TFormer_ProjectVarItGetComment

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_ProjectVarItGetComment(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_ProjectVarItGetCommentW(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

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

The comment 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 comment of the DataField the iterator is pointing to. This comment 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