C_GetNamedValue

Each OrcaFlex object maintains an table of integers, indexed by a user-specified name, which is intended for use by related external functions to co-ordinate their related working data. The integer type used, INT_PTR is pointer sized to enable you to store pointers in the table.

Note:

These tables are cleared when OrcaFlex begins its statics calculation.

Call C_GetNamedValue to read from the table. Values can be written to the table by calling C_SetNamedValue.

INT_PTR C_GetNamedValue(

TOrcFxAPIHandle ObjectHandle,

LPCTSTR lpName,

int *lpStatus

);

ObjectHandle (IN)

The handle of an object.

lpName (IN)

The name of the item in the table.

lpStatus (OUT)

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

Return Value

The value stored in the table. If no value has been stored in the table then 0 is returned.

Unicode and ANSI