TFormer_GetFirstProjectIt

Definition

HPROJECT_ITERATOR TFormer_GetFirstProjectIt(HTFORM pInstance, ERRCODE * peCode);

Contract

Creates a new iterator and sets its position to the first Project within the Repository.

This function is used for enumerating Projects within the actual Repository. It returns an iterator and sets its position to the first Project. Use TFormer_ProjectItGetName and TFormer_ProjectItGetDescription to retrieve the name and description of the actual Project.

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
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success

Note

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