GFA Boolean

Functions
peak_status	peak_GFA_Boolean_Set (peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool booleanValue)
	Set the boolean feature with the given name.
peak_status	peak_GFA_Boolean_Get (peak_camera_handle hCam, peak_gfa_module module, const char *booleanFeatureName, peak_bool *booleanValue)
	Get the boolean feature with the given name.

Detailed Description

Generic boolean feature access related functions and types.

Function Documentation

peak_GFA_Boolean_Get()

peak_status peak_GFA_Boolean_Get	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	booleanFeatureName,
		peak_bool *	booleanValue
	)

Get the boolean feature with the given name.

Reads the current value of the boolean feature with the given name.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	booleanFeatureName	The name of the boolean feature as a zero-terminated string.
[out]	booleanValue	The value of the boolean feature.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The boolean feature is not available for read access. Check the access status via peak_GFA_Feature_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or booleanFeatureName and/or booleanValue are invalid pointers or booleanFeatureName is not zero-terminated. Check peak_gfa_module.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).

peak_GFA_Boolean_Set()

peak_status peak_GFA_Boolean_Set	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	booleanFeatureName,
		peak_bool	booleanValue
	)

Set the boolean feature with the given name.

Writes the desired value to the boolean feature with the given name.

Note

The write access is only available in the GFA write access mode. See peak_GFA_EnableWriteAccess.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	booleanFeatureName	The name of the boolean feature as a zero-terminated string.
[in]	booleanValue	The boolean value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE booleanValue is out of range. Valid values are PEAK_TRUE and PEAK_FALSE.

PEAK_STATUS_ACCESS_DENIED The boolean feature is not available for write access. Check the access status via peak_GFA_Feature_GetAccessStatus. Check for the GFA write access mode to be enabled via peak_GFA_IsWriteAccessEnabled.

PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or booleanFeatureName is an invalid pointer or it is not zero-terminated. Check peak_gfa_module.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

For a description of the generic feature access concept see Generic Feature Access (GFA).