TFormer_FormItGetDescription

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_FormItGetDescription(HFORM_ITERATOR hFormIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_FormItGetDescriptionW(HFORM_ITERATOR hFormIt, ERRCODE * peCode);

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

The FormLayout description may be empty.

The returned pointer is for temporary use only!

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

Parameter / type	Description
`hFormIt`HFORM_ITERATOR	FormLayout iterator (see TFormer_GetFirstFormIt)
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success