C_DataRequiresIndex

Call C_DataRequiresIndex to determine whether or not a call to get or set a data item (e.g. C_GetDataDouble, C_SetDataDouble etc.) requires the Index parameter to be specified.

void C_DataRequiresIndex(

TOrcFxAPIHandle ObjectHandle,

LPCTSTR lpDataName,

BOOL *lpDataRequiresIndex,

int *lpStatus

);

Parameters

ObjectHandle (IN)

The handle of the object which owns the data.

lpDataName (IN)

Points to a null-terminated string containing the name of the data item. This is the same name as used in OrcaFlex script files. To find what the name is for a particular data item you should select the data item on the OrcaFlex data form and press F7. For more information see the batch processing section of the OrcaFlex documentation.

lpDataRequiresIndex (OUT)

Points to a variable which receives a boolean indicating whether or not the specified data requires an index.

lpStatus (OUT)

Points to a variable in which the status result for the function call will be returned.

Unicode and ANSI

The Unicode function name is C_DataRequiresIndexW and the ANSI function name is C_DataRequiresIndexA.