Functions
peak_bool	peak_GFA_Integer_HasRange (peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName)
	Check whether the valid values for the integer feature with the given name are organized as a range. More...

peak_status	peak_GFA_Integer_GetRange (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t minIntegerValue, int64_t maxIntegerValue, int64_t incIntegerValue)
	Get the current range of valid values for the integer feature with the given name. More...

peak_status	peak_GFA_Integer_GetList (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t integerList, size_t *integerCount)
	Get the list of currently selectable values for the integer feature with the given name. More...

peak_status	peak_GFA_Integer_Set (peak_camera_handle hCam, peak_gfa_module module, const char *integerFeatureName, int64_t integerValue)
	Set the integer feature with the given name. More...

peak_status	peak_GFA_Integer_Get (peak_camera_handle hCam, peak_gfa_module module, const char integerFeatureName, int64_t integerValue)
	Get the integer feature with the given name. More...

Detailed Description

Generic integer feature access related functions and types.

Function Documentation

◆ peak_GFA_Integer_Get()

peak_status peak_GFA_Integer_Get	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	integerFeatureName,
		int64_t *	integerValue
	)

Get the integer feature with the given name.

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

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	integerFeatureName	The name of the integer feature as a zero-terminated string.
[out]	integerValue	The value of the integer feature.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The integer 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 integerFeatureName and/or integerValue are invalid pointers or integerFeatureName 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_Integer_GetList()

peak_status peak_GFA_Integer_GetList	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	integerFeatureName,
		int64_t *	integerList,
		size_t *	integerCount
	)

Get the list of currently selectable values for the integer feature with the given name.

Queries the list of currently selectable values for the integer feature with the given name.

The list of selectable integer values may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	integerFeatureName	The name of the integer feature as a zero-terminated string.
[out]	integerList	Pointer to a user allocated array buffer to receive the integer value list. If this parameter is NULL, `integerCount` will contain the current number of integer values. The required size of `integerList` in bytes is `integerCount` x sizeof(int64_t).
[in,out]	integerCount	`integerList` equal NULL: out: minimal number of integer values `integerList` must be large enough to hold `integerList` unequal NULL: in: number of integer values `integerList` can hold out: number of integer values filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_NO_DATA The valid values for the integer feature are organized as range rather than as a list.
Use peak_GFA_Integer_GetRange to query the valid integer values.; PEAK_STATUS_BUFFER_TOO_SMALL integerList is not NULL and the value of *integerCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The integer feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module. or integerFeatureName and/or integerCount are invalid pointers or integerFeatureName 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.

Note: Consider that the integer value list might change between the size query call and the list query call.
This may be the case if the camera configuration or the camera status have changed in the time between the two function calls.

◆ peak_GFA_Integer_GetRange()

peak_status peak_GFA_Integer_GetRange	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	integerFeatureName,
		int64_t *	minIntegerValue,
		int64_t *	maxIntegerValue,
		int64_t *	incIntegerValue
	)

Get the current range of valid values for the integer feature with the given name.

Queries the current range of valid values for the integer feature with the given name.

The range of valid values for the integer feature with the given name may depend on the camera configuration and the camera status.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	integerFeatureName	The name of the integer feature as a zero-terminated string.
[out]	minIntegerValue	The minimum value for the integer feature.
[out]	maxIntegerValue	The maximum value for the integer feature.
[out]	incIntegerValue	The increment for the integer feature.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_NO_DATA The valid values for the integer feature are organized as list rather than as a range.
Use peak_GFA_Integer_GetList to query the valid integer values.; PEAK_STATUS_ACCESS_DENIED The integer feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or at least one of integerFeatureName, minIntegerValue, maxIntegerValue, and incIntegerValue is an invalid pointer or integerFeatureName 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_Integer_HasRange()

peak_bool peak_GFA_Integer_HasRange	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	integerFeatureName
	)

Check whether the valid values for the integer feature with the given name are organized as a range.

Checks whether the valid values for the integer feature with the given name are organized as a range or as a list.

This function implements the Valid Values Organization Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	integerFeatureName	The name of the integer feature as a zero-terminated string.

Returns: PEAK_TRUE The valid values are organized as a range. Use peak_GFA_Integer_GetRange.; PEAK_FALSE The valid values are organized as a list. Use peak_GFA_Integer_GetList.

◆ peak_GFA_Integer_Set()

peak_status peak_GFA_Integer_Set	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	integerFeatureName,
		int64_t	integerValue
	)

Set the integer feature with the given name.

Writes the desired value to the integer 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]	integerFeatureName	The name of the integer feature as a zero-terminated string.
[in]	integerValue	The integer value to set.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_OUT_OF_RANGE integerValue is out of range. Check the range of valid values via peak_GFA_Integer_GetRange or peak_GFA_Integer_GetList.; PEAK_STATUS_ACCESS_DENIED The integer 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 integerFeatureName 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).

Functions

Detailed Description

Function Documentation

◆ peak_GFA_Integer_Get()

◆ peak_GFA_Integer_GetList()

◆ peak_GFA_Integer_GetRange()

◆ peak_GFA_Integer_HasRange()

◆ peak_GFA_Integer_Set()