IBoolean Access

The functions in this section provide access to boolean nodes using the bool8_t data type, values represented with 'True' and 'False'. This includes value getters and setters. More...

Functions
SPINNAKERC_API	spinBooleanSetValue (spinNodeHandle hNode, bool8_t value)
	Sets the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1') More...
SPINNAKERC_API	spinBooleanGetValue (spinNodeHandle hNode, bool8_t *pbValue)
	Retrieves the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1') More...

Detailed Description

The functions in this section provide access to boolean nodes using the bool8_t data type, values represented with 'True' and 'False'. This includes value getters and setters.

Function Documentation

spinBooleanGetValue()

SPINNAKERC_API spinBooleanGetValue	(	spinNodeHandle	hNode,
		bool8_t *	pbValue
	)

Retrieves the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1')

See also

spinError

Parameters

hNode	The boolean node of the value to read
pValue	The boolean pointer in which the value is returned

Returns

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

Examples

ChunkData_C.c, EnumerationEvents_C.c, NodeMapCallback_C.c, and NodeMapInfo_C.c.

spinBooleanSetValue()

SPINNAKERC_API spinBooleanSetValue	(	spinNodeHandle	hNode,
		bool8_t	value
	)

Sets the value of a boolean node; boolean values are represented by 'True' (which equals '0') and 'False' (which equals '1')

See also

spinError

Parameters

hNode	The boolean node having its value changed
value	The boolean value to set

Returns

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

Examples

Acquisition_C.c, AcquisitionMultipleCamera_C.c, ChunkData_C.c, and LookupTable_C.c.