C_GetObjectTypeName

Call C_GetObjectTypeName to obtain a textual description of the object type specified by the ObjectType parameter. This function is the inverse of C_GetObjectType

int C_GetObjectTypeName(

TOrcFxAPIHandle ModelHandle,

int ObjectType,

LPTSTR lpObjectTypeName,

int *lpStatus

);

Parameters

ModelHandle (IN)

The handle of the model.

ObjectType (IN)

One of the object type constants defined in OrcFxAPI.h (e.g. otVessel) or the ObjectType member of the TObjectInfo structure.

lpObjectTypeName (OUT)

Points to a block of memory to receive the object type name string. The block of memory must be large enough for the object type name string. To find out how much memory to allocate call C_GetObjectTypeName passing NULL as the lpObjectTypeName parameter and use the return value to determine how much memory to allocate.

lpStatus (OUT)

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

Return Value

The length of the object type name string.

Unicode and ANSI

The Unicode function name is C_GetObjectTypeNameW and the ANSI function name is C_GetObjectTypeNameA.