TFormer_DSParameterItGetDisplayOrder

Repository Access · String encodings

Definition

Windows: ANSI; Unix: UTF-8

LPCSTR TFormer_DSParameterItGetDisplayOrder(HDSPARAMETER_ITERATOR hIt, ERRCODE * peCode);

Windows only: UTF-16

LPCWSTR TFormer_DSParameterItGetDisplayOrderW(HDSPARAMETER_ITERATOR hIt, ERRCODE * peCode);

Contract

Returns the display-order of the DataSourceParameter the iterator is pointing to.

This value is used for assigning a display-order to a DataSourceParameter. A good example is an application which presents a sorted list of DataSourceParameters to the user.

The returned pointer is for temporary use only!

Returns

The display-order of the DataSourceParameter the iterator is pointing to. The display-order is only valid if peCode is ErrOk (0).

Parameters

Parameter / typeDescription
hItHDSPARAMETER_ITERATOR


DataSource parameter iterator (see TFormer_GetFirstDSParameterIt)

peCodeERRCODE *


Error code, ErrOk (0) in case of success

Search documentation

Search in
More scopes
Additional scopes

All contents