TFormer_GetFirstFormIt

Definition

Windows: ANSI; Unix: UTF-8

HFORM_ITERATOR TFormer_GetFirstFormIt(HTFORM pInstance, LPCSTR pszProjectName, ERRCODE * peCode);

Windows only: UTF-16

HFORM_ITERATOR TFormer_GetFirstFormItW(HTFORM pInstance, LPCWSTR pszProjectName, ERRCODE * peCode);

Contract

Returns an iterator pointing to the first FormLayout in the specified Project.

Creates a new FormLayout iterator and sets its position to the first FormLayout in the Project specified by pszProjectName. To get the name of the FormLayout call TFormer_FormItGetName.

Returns

Iterator in case of success, NULL in case of an error (check peCode in this case)

Parameters

Parameter / type	Description
`pInstance`HTFORM	The TFORMer instance provided by a previous call to TFormer_Init
`pszProjectName`LPCSTR / LPCWSTR	The name of the Project within the Repository.
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success

Note

Release the iterator after use with TFormer_FreeFormIt! Memory leaks may occur otherwise.