TFormer_ProjectVarItGetDescription
Repository Access · String encodings
Definition
Windows: ANSI; Unix: UTF-8
LPCSTR TFormer_ProjectVarItGetDescription(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);
Windows only: UTF-16
LPCWSTR TFormer_ProjectVarItGetDescriptionW(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);Contract
Returns the description of the DataField 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 DataField.
The returned pointer is for temporary use only!
Returns
The description of the DataField the iterator is pointing to. This description is only valid if peCode is ErrOk (0).
Parameters
| Parameter / type | Description |
|---|---|
hProjectVarItHPROJECTVAR_ITERATOR |
|
peCodeERRCODE * |
|