TFormer_ProjectVarItGetDefValue

Repository Access · String encodings

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_ProjectVarItGetDefValue(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_ProjectVarItGetDefValueW(HPROJECTVAR_ITERATOR hProjectVarIt, ERRCODE * peCode);

Contract

Returns the default-value of the DataField the iterator is pointing to.

The default value is the standard-value of a DataField when creating data manually or automatically within TFORMer Designer. The default value is only used by TFORMer Designer. When a DataSource is used to pass data to TFORMer SDK and a DataField is not set by this DataSource the value of the DataField will be an empty string ("") or 0. See also TFormer_SetReuseValues.

The returned pointer is for temporary use only!

Returns

The default value of the DataField the iterator is pointing to. This value is only valid if peCode is ErrOk (0).

Parameters

Parameter / typeDescription
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