TFormer_ProjectItGetDescription

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_ProjectItGetDescription(HPROJECT_ITERATOR hProjectIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_ProjectItGetDescriptionW(HPROJECT_ITERATOR hProjectIt, ERRCODE * peCode);

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

The Project description may be empty.

The returned pointer is for temporary use only!

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

Parameter / type	Description
`hProjectIt`HPROJECT_ITERATOR	Project iterator (see TFormer_GetFirstProjectIt)
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success