nxLibGetJsonMeta

Navigation:  NxLib API > C Interface > Read Access >

nxLibGetJsonMeta

Previous pageReturn to chapter overviewNext page

Retrieves an item value or an entire subtree in JSON represetation including item metadata (protection, extended type, internal flags). This function is only intended to be used by NxTreeEdit to visualize the entire tree state.

Signature

NXLIBSTR nxLibGetJsonMeta (NXLIBERR* result, NXLIBSTR itemPath, NXLIBINT numLevels, NXLIBBOOL prettyPrint, NXLIBINT numberPrecision, NXLIBBOOL scientificNumberFormat);

Parameters

result

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

itemPath

The path of the item to access.

numLevels

The depth of the returned subtree. Nodes in lower levels will be omitted.

prettyPrint

Specify true here to format the resulting string with line breaks and tabs.

numberPrecision

The floating point precision of the returned numbers.

scientificNumberFormat

Specifies whether to use scientific notation for all numbers.

Return Value

A JSON string representing the item value or subtree including each item's metadata.