nxLibGetType

Navigation:  NxLib API > C Interface > Read Access >

nxLibGetType

Previous pageReturn to chapter overviewNext page

Retrieves the item type a tree item.

Signature

NXLIBINT nxLibGetType (NXLIBINT* result, NXLIBSTR itemPath);

Parameters

result

A pointer to a variable for the error code of the operation.

itemPath

The path of the item to access.

Return Value

The type identifier of the basic type of the item.

NxLibItemTypeInvalid

An error occurred, refer to result for further information.

NxLibItemTypeNull

The item is of type Null.

NxLibItemTypeNumber

The item is a Number. This can be an integer or floating point value.

NxLibItemTypeString

The item is a String.

NxLibItemTypeBool

The item is a Boolean value.

NxLibItemTypeArray

The item is an Array. The number of array elements can be queried with nxLibGetCount. The array can be empty.

NxLibItemTypeObject

The item is an Object. The number of subitems can be queried with nxLibGetCount. The object can be empty.