GFA Register

Functions
peak_status	peak_GFA_Register_Set (peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, const uint8_t *registerValue, size_t registerValueSize)
	Set the register feature with the given name. More...
peak_status	peak_GFA_Register_Get (peak_camera_handle hCam, peak_gfa_module module, const char *registerFeatureName, uint8_t *registerValue, size_t *registerValueSize)
	Get the register feature with the given name. More...

Detailed Description

Generic register access related functions and types.

Function Documentation

peak_GFA_Register_Get()

peak_status peak_GFA_Register_Get	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	registerFeatureName,
		uint8_t *	registerValue,
		size_t *	registerValueSize
	)

Get the register feature with the given name.

Reads the current value/data of the register feature with the given name.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	registerFeatureName	The name of the string feature as a zero-terminated string.
[out]	registerValue	Pointer to a user allocated buffer to receive the value/data of the register feature. If this parameter is NULL, registerValueSize will contain the size of the register data. The required size of registerValueSize in bytes is registerValueSize x sizeof(char).
[in,out]	registerValueSize	registerValue equal NULL: out: minimal number of bytes registerValue must be large enough to hold registerValue unequal NULL: in: number of bytes registerValue can hold out: number of bytes filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_BUFFER_TOO_SMALL registerValue is not NULL and the value of *registerValueSize is too small to receive the expected amount of data.

PEAK_STATUS_ACCESS_DENIED The string 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 at least one of registerFeatureName, registerValue, and registerValueSize is an invalid pointer or registerFeatureName 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_Register_Set()

peak_status peak_GFA_Register_Set	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	registerFeatureName,
		const uint8_t *	registerValue,
		size_t	registerValueSize
	)

Set the register feature with the given name.

Writes the desired value/data to the register 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]	registerFeatureName	The name of the register feature as a zero-terminated string.
[in]	registerValue	The register value/data to set.
[in]	registerValueSize	The size of *registerValue in bytes.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The register 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 registerFeatureName and/or registerValue are invalid pointers or registerFeatureName is not zero-terminated or registerValueSize is 0. 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).