TFormer_DatasourceItGetDescription

Repository Access · String encodings

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_DatasourceItGetDescription(HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_DatasourceItGetDescriptionW(HDATASOURCE_ITERATOR hDatasourceIt, ERRCODE * peCode);

Contract

Returns the description of the DataSource the iterator is pointing to.

The DataSource description may be empty.

The returned pointer is for temporary use only!

Returns

The description of the DataSource the iterator is pointing to. This description is only valid if peCode is ErrOk (0).

Parameters

Parameter / typeDescription
hDatasourceItHDATASOURCE_ITERATOR


DataSource iterator (see TFormer_GetFirstDatasourceIt)

peCodeERRCODE *


Error code, ErrOk (0) in case of success

Search documentation

Search in
More scopes
Additional scopes

All contents