String Access

The functions in this section provide access to string nodes using character pointers and arrays. This includes getters and setters of values and value lengths. More...

Functions
SPINNAKERC_API	spinStringSetValue (spinNodeHandle hNode, const char *pBuf)
	Sets the value of a string node. More...
SPINNAKERC_API	spinStringSetValueEx (spinNodeHandle hNode, bool8_t bVerify, const char *pBuf)
	Sets the value of a string node; manually set whether to verify the node. More...
SPINNAKERC_API	spinStringGetValue (spinNodeHandle hNode, char *pBuf, size_t *pBufLen)
	Retrieves the value of a string node as a c-string. More...
SPINNAKERC_API	spinStringGetValueEx (spinNodeHandle hNode, bool8_t bVerify, char *pBuf, size_t *pBufLen)
	Retrieves the value of a string node as a cstring; manually set whether to verify the node. More...
SPINNAKERC_API	spinStringGetMaxLength (spinNodeHandle hNode, int64_t *pValue)
	Retrieves the maximum length of the c-string to be returned. More...

Detailed Description

The functions in this section provide access to string nodes using character pointers and arrays. This includes getters and setters of values and value lengths.

Function Documentation

spinStringGetMaxLength()

SPINNAKERC_API spinStringGetMaxLength	(	spinNodeHandle	hNode,
		int64_t *	pValue
	)

Retrieves the maximum length of the c-string to be returned.

See also

spinError

Parameters

hNode	The string node of the length to retrieve
pValue	The integer pointer in which the maximum length of the c-string is returned

Returns

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

spinStringGetValue()

SPINNAKERC_API spinStringGetValue	(	spinNodeHandle	hNode,
		char *	pBuf,
		size_t *	pBufLen
	)

Retrieves the value of a string node as a c-string.

See also

spinError

Parameters

hNode	The string 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, Enumeration_C.c, Enumeration_C_QuickSpin.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, SaveToVideo_C.c, Sequencer_C.c, Trigger_C.c, and Trigger_C_QuickSpin.c.

spinStringGetValueEx()

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

Retrieves the value of a string node as a cstring; manually set whether to verify the node.

See also

spinError

Parameters

hNode	The string 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

spinStringSetValue()

SPINNAKERC_API spinStringSetValue	(	spinNodeHandle	hNode,
		const char *	pBuf
	)

Sets the value of a string node.

See also

spinError

Parameters

hNode	The string 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

spinStringSetValueEx()

SPINNAKERC_API spinStringSetValueEx	(	spinNodeHandle	hNode,
		bool8_t	bVerify,
		const char *	pBuf
	)

Sets the value of a string node; manually set whether to verify the node.

See also

spinError

Parameters

hNode	The string 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