TFormer_DSParameterItGetDescription
Repository Access · String encodings
Definition
Windows: ANSI; Unix: UTF-8
LPCSTR TFormer_DSParameterItGetDescription(HDSPARAMETER_ITERATOR hIt, ERRCODE * peCode);
Windows only: UTF-16
LPCWSTR TFormer_DSParameterItGetDescriptionW(HDSPARAMETER_ITERATOR hIt, ERRCODE * peCode);Contract
Returns the description of the DataSourceParameter the iterator is pointing to.
The description is only used for informational purposes and for providing the end-user additional information describing the purpose of the DataSourceParameter.
The returned pointer is for temporary use only!
Returns
The description of the DataSourceParameter the iterator is pointing to. This description is only valid if peCode is ErrOk (0).
Parameters
| Parameter / type | Description |
|---|---|
hItHDSPARAMETER_ITERATOR |
|
peCodeERRCODE * |
|