nxLibGetBinaryInfo

Navigation:  NxLib API > C Interface > Read Access >

nxLibGetBinaryInfo

Previous pageReturn to chapter overviewNext page

Retrieves meta data of a Binary item.

Signature

void nxLibGetBinaryInfo (NXLIBERR* result, NXLIBSTR itemPath, NXLIBINT* width, NXLIBINT* height, NXLIBINT* channelCount, NXLIBINT* bytesPerElement, NXLIBBOOL* isFloat, NXLIBDOUBLE* timestamp);

Parameters

result

The error code of the operation.

itemPath

The path of the item to access.

width

The width of the array (consecutive elements in memory).

height

The height of the array (number of rows of width*channelCount elements)

channelCount

Number of channels for a single item.

bytesPerElement

Size in bytes of a single channel value of an item.

isFloat

Specifies whether the element data type is a floating point type.

timestamp

The current timestamp of the binary blob queried.

Note: The entire size of the binary blob is width*height*channelCount*bytesPerElement. A 24bit RGB image of VGA resolution would have width == 640, height == 480, channelCount == 3, bytesPerElement == 1 and isFloat == NXLIBFALSE.

Return Value

none