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. More...

Functions
SPINNAKERC_API	spinNodeToString (spinNodeHandle hNode, char pBuf, size_t pBufLen)
	Retrieves the value of any node type as a c-string. More...

SPINNAKERC_API	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. More...

SPINNAKERC_API	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. More...

SPINNAKERC_API	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. More...

Detailed Description

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.

Function Documentation

◆ spinNodeFromString()

SPINNAKERC_API 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

◆ spinNodeFromStringEx()

SPINNAKERC_API 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

◆ spinNodeToString()

SPINNAKERC_API 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

Examples: Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, Exposure_C.c, Exposure_C_Quickspin.c, ImageEvents_C.c, ImageFormatControl_C.c, ImageFormatControl_C_Quickspin.c, LookupTable_C.c, NodeMapCallback_C.c, NodeMapInfo_C.c, NodeMapInfo_C_QuickSpin.c, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

◆ spinNodeToStringEx()

SPINNAKERC_API 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