TFormer_ProjectVarItGetCaption

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_ProjectVarItGetCaption(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_ProjectVarItGetCaptionW(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Returns the caption of the DataField the iterator is pointing to.

The caption 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!

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

Parameter / type	Description
`hProjectVarIt`HPROJECTVAR_ITERATOR	DataField iterator (see TFormer_GetFirstProjectVarIt)
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success