C_GetVariableDataType

Call C_GetVariableDataType to determine whether a variable data item is currently a constant value or is currently variable. You should only call this function if a call to C_GetDataType returns dtVariable.

void C_GetVariableDataType(

TOrcFxAPIHandle ObjectHandle,

LPCTSTR lpDataName,

int Index,

int *lpDataType,

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.

Index (IN)

If the data item is part of a table then this is the row number of the table. The first row in the table is always 1. If the data item is not part of a table then this parameter is ignored. You can use C_DataRequiresIndex to determine whether or not an index is required.

lpDataType (OUT)

Points to a variable which receives the data type. Can be one of the following values:

dtDouble which means the data item is a constant value and you should call C_GetDataDouble to get this value.
dtString which means the data item is a variable value and you should call C_GetDataString to get the name of the variable parameter which specifies the data.

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_GetVariableDataTypeW and the ANSI function name is C_GetVariableDataTypeA.