Group CIValueAccess¶

Modules > CIValueAccess

The functions in this section provide access to nodes as value nodes. As value nodes are not an actual node type, the functions are named as regular nodes. Functions include reading from and writing to any node with a string.

Public Functions¶

Type	Name
	spinNodeFromString (spinNodeHandle hNode, const char * pBuf)
	spinNodeFromStringEx (spinNodeHandle hNode, bool8_t bVerify, const char * pBuf)
	spinNodeToString (spinNodeHandle hNode, char * pBuf, size_t * pBufLen)
	spinNodeToStringEx (spinNodeHandle hNode, bool8_t bVerify, char * pBuf, size_t * pBufLen)

Public Functions Documentation¶

function spinNodeFromString¶

spinNodeFromString (
    spinNodeHandle hNode,
    const char * pBuf
)

Sets the value of any node type from a c-string; it is important to ensure that the value of the c-string is appropriate to the node type

See also: spinError

Parameters:

hNode The node having its value changed
pBuf The c-string of the value to set

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeFromStringEx¶

spinNodeFromStringEx (
    spinNodeHandle hNode,
    bool8_t bVerify,
    const char * pBuf
)

Sets the value of any node type from a c-string; manually set whether to verify the node; ensure the value of the c-string is appropriate to the node type

See also: spinError

Parameters:

hNode The node having its value changed
bVerify The boolean of whether to verify the node
pBuf The c-string of the value to set

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeToString¶

spinNodeToString (
    spinNodeHandle hNode,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the value of any node type as a c-string

See also: spinError

Parameters:

hNode The node of the value to read
pBuf The c-string character buffer in which the value of the node is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error

function spinNodeToStringEx¶

spinNodeToStringEx (
    spinNodeHandle hNode,
    bool8_t bVerify,
    char * pBuf,
    size_t * pBufLen
)

Retrieves the value of any node type as a c-string; manually set whether to verify the node

See also: spinError

Parameters:

hNode The node of the value to read
bVerify The boolean of whether to verify the node
pBuf The c-string character buffer in which the value of the node is returned
pBufLen The unsigned integer pointer in which the length of the c-string is returned; the input value is the maximum length

Returns:

spinError The error code; returns SPINNAKER_ERR_SUCCESS (or 0) for no error