TFormer_GetFirstDSParameterIt

Definition

Windows: ANSI; Unix: UTF-8

HDSPARAMETER_ITERATOR TFormer_GetFirstDSParameterIt(HTFORM pInstance, LPCSTR pszProjectName, LPCSTR pszDatasourceName, ERRCODE * peCode);

Windows only: UTF-16

HDSPARAMETER_ITERATOR TFormer_GetFirstDSParameterItW(HTFORM pInstance, LPCWSTR pszProjectName, LPCWSTR pszDatasourceName, ERRCODE * peCode);

Returns an iterator pointing to the first DataSourceParameter of the specified DataSource in the specified Project.

Creates a new DataSourceParameter iterator and sets its position to the first DataSourceParameter in the DataSource specified by pszDatasourceName. To enumerate DataSourceParameters of a global DataSource, set pszProjectName to NULL or an empty string. To retrieve the name of the DataSourceParameter call TFormer_DSParameterItGetName.

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

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.
`pszDatasourceName`LPCSTR / LPCWSTR	The name of the DataSource within the Project.
`peCode`ERRCODE *	Error code, `ErrOk` (0) in case of success

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