TFormer_ProjectVarItGetUsage

Repository Access

Definition

EVarUsage TFormer_ProjectVarItGetUsage(HTFORM pInstance, HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Contract

Returns the usage of the DataField specified by an iterator.

A FormLayout utilizes user- or system DataFields as place-holders for dynamic data. Values for such DataFields are usually provided by the user (entered manually in TFORMer Designer) or imported from a DataSource. Each DataField can be used on its own, as part of expressions (e.g. in a text- or bar-code element) or it may be computed within the FormLayout itself (e.g. pre- and post-expressions). This method queries the FormLayout and returns an enumeration (see EVarUsage) regarding the use of a specific DataField in the FormLayout.

Returns

The usage of the DataField in the current FormLayout. This value is only valid if peCode is ErrOk (0).

Parameters

Parameter / typeDescription
pInstanceHTFORM


The TFORMer instance provided by a previous call to TFormer_Init

hProjectVarItHPROJECTVAR_ITERATOR


DataField iterator (see TFormer_GetFirstProjectVarIt)

peCodeERRCODE *


Error code, ErrOk (0) in case of success

Search documentation

Search in
More scopes
Additional scopes

All contents