TFormer_GetFirstDatasourceIt

Repository Access · String encodings

Definition

Windows: ANSI; Unix: UTF-8

HDATASOURCE_ITERATOR TFormer_GetFirstDatasourceIt(HTFORM pInstance, LPCSTR pszProjectName, ERRCODE * peCode);

Windows only: UTF-16

HDATASOURCE_ITERATOR TFormer_GetFirstDatasourceItW(HTFORM pInstance, LPCWSTR pszProjectName, ERRCODE * peCode);

Contract

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

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

Returns

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

Parameters

Parameter / typeDescription
pInstanceHTFORM


The TFORMer instance provided by a previous call to TFormer_Init

pszProjectNameLPCSTR / LPCWSTR


The name of the Project within the Repository.

peCodeERRCODE *


Error code, ErrOk (0) in case of success

Note

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

Search documentation

Search in
More scopes
Additional scopes

All contents