Group CIBoolean¶

Modules > CIBoolean

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.

Public Functions¶

Type	Name
	spinBooleanGetValue (spinNodeHandle hNode, bool8_t * pbValue)
	spinBooleanSetValue (spinNodeHandle hNode, bool8_t value)

Public Functions Documentation¶

function spinBooleanGetValue¶

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

function spinBooleanSetValue¶

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