GFA Command

Functions
peak_status	peak_GFA_Command_Execute (peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName)
	Execute the command feature with the given name. More...
peak_status	peak_GFA_Command_WaitForDone (peak_camera_handle hCam, peak_gfa_module module, const char *commandFeatureName, uint32_t timeout_ms)
	Wait for the execution of the command feature with the given name to be done. More...

Detailed Description

Generic command feature access related functions and types.

Function Documentation

peak_GFA_Command_Execute()

peak_status peak_GFA_Command_Execute	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	commandFeatureName
	)

Execute the command feature with the given name.

Writes the execute request to the command 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]	commandFeatureName	The name of the command feature as a zero-terminated string.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The command 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 commandFeatureName 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).

peak_GFA_Command_WaitForDone()

peak_status peak_GFA_Command_WaitForDone	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	commandFeatureName,
		uint32_t	timeout_ms
	)

Wait for the execution of the command feature with the given name to be done.

Blocks and reads the status of the execution request for the command feature with the given name until it is done or a timeout occurs.
If the command has not been executed the function will immediately return with PEAK_STATUS_SUCCESS.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	commandFeatureName	The name of the command feature as a zero-terminated string.
[in]	timeout_ms	The wait timeout in milliseconds.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The command 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 commandFeatureName 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_TIMEOUT The wait timeout has elapsed and the command execution has not been indicated.

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).

Note

The purpose of the timeout parameter is to cancel the wait in case of a malfunction of the command mechanism. If the applications control flow depends on the command execution to be done before it proceeds it should call this function with a reasonable timeout and take action for the case that the wait times out. A pending call to this function can not be aborted.