Boolean Properties

Boolean properties represent a feature whose value is a simple on/off switch. More...

Functions
bool	ic4_prop_boolean_set_value (struct IC4_PROPERTY *prop, bool value)
	Changes the value of a boolean property.
bool	ic4_prop_boolean_get_value (struct IC4_PROPERTY *prop, bool *pValue)
	Reads the current value of a boolean property.

Detailed Description

Boolean properties represent a feature whose value is a simple on/off switch.

Function Documentation

ic4_prop_boolean_get_value()

bool ic4_prop_boolean_get_value	(	struct IC4_PROPERTY *	prop,
		bool *	pValue
	)

Reads the current value of a boolean property.

Parameters

[in]	prop	A boolean property
[out]	pValue	Pointer to a bool to receive the current value

Returns

true on success, otherwise false.
Use ic4_get_last_error() to query error information.

Remarks

If prop is not a boolean property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.

ic4_prop_boolean_set_value()

bool ic4_prop_boolean_set_value	(	struct IC4_PROPERTY *	prop,
		bool	value
	)

Changes the value of a boolean property.

Parameters

[in]	prop	An boolean property
[in]	value	The new value to set

Returns

true on success, otherwise false.
Use ic4_get_last_error() to query error information.

Remarks

If prop is not a boolean property, the function fails and the error value is set to IC4_ERROR_GENICAM_TYPE_MISMATCH.
If the value is currently not writable, the function fails and the error value is set to IC4_ERROR_GENICAM_ACCESS_DENIED.