GFA Enumeration

Data Structures
struct	peak_gfa_enumeration_entry
	peak GFA enumeration entry More...

Functions
peak_status	peak_GFA_Enumeration_GetList (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntryList, size_t *enumerationEntryCount)
	Get the list of currently selectable enumeration entries.
peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatus (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
	Query the access status of the enumeration entry.
peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
	Query the access status of the enumeration entry by its symbolic value.
peak_access_status	peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
	Query the access status of the enumeration entry by its integer value.
peak_status	peak_GFA_Enumeration_Set (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const peak_gfa_enumeration_entry *enumerationEntry)
	Set the enumeration feature with the given name.
peak_status	peak_GFA_Enumeration_SetBySymbolicValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, const char *enumerationEntrySymbolicValue)
	Set the enumeration feature with the given name by the entries symbolic value.
peak_status	peak_GFA_Enumeration_SetByIntegerValue (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, int64_t enumerationEntryIntegerValue)
	Set the enumeration feature with the given name by the entries integer value.
peak_status	peak_GFA_Enumeration_Get (peak_camera_handle hCam, peak_gfa_module module, const char *enumerationFeatureName, peak_gfa_enumeration_entry *enumerationEntry)
	Get the enumeration feature with the given name.

Detailed Description

Generic enumeration feature access related functions and types.

Function Documentation

peak_GFA_Enumeration_Get()

peak_status peak_GFA_Enumeration_Get	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		peak_gfa_enumeration_entry *	enumerationEntry )

Get the enumeration feature with the given name.

Reads the current enumeration entry value of the enumeration feature with the given name.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[out]	enumerationEntry	The current enumeration entry value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The enumeration 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 enumerationFeatureName and/or enumerationEntry are invalid pointers or enumerationFeatureName 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).

Since

1.0

peak_GFA_Enumeration_GetList()

peak_status peak_GFA_Enumeration_GetList	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		peak_gfa_enumeration_entry *	enumerationEntryList,
		size_t *	enumerationEntryCount )

Get the list of currently selectable enumeration entries.

Queries the list of currently selectable enumeration entries.

The list of selectable enumeration entries 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]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[out]	enumerationEntryList	Pointer to a user allocated array buffer to receive the enumeration entry list. If this parameter is NULL, enumerationEntryCount will contain the current number of enumeration entries. The required size of enumerationEntryList in bytes is enumerationEntryCount x sizeof(peak_gfa_enumeration_entry).
[in,out]	enumerationEntryCount	enumerationEntryList equal NULL: out: minimal number of enumeration entries enumerationEntryList must be large enough to hold enumerationEntryList unequal NULL: in: number of enumeration entries enumerationEntryList can hold out: number of enumeration entries filled by the function

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

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

PEAK_STATUS_ACCESS_DENIED The enumeration feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or enumerationFeatureName and/or enumerationEntryCount are invalid pointers or enumerationFeatureName 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 enumeration entry 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.

Since

1.0

peak_GFA_Enumeration_Set()

peak_status peak_GFA_Enumeration_Set	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		const peak_gfa_enumeration_entry *	enumerationEntry )

Set the enumeration feature with the given name.

Writes the desired enumeration entry value to the enumeration 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]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntry	The enumeration entry value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE enumerationEntry is out of range. Check the range of valid values via peak_GFA_Enumeration_GetList.

PEAK_STATUS_ACCESS_DENIED The enumeration 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 enumerationFeatureName and/or enumerationEntry are invalid pointers or enumerationFeatureName is not zero-terminated or enumerationEntry is an invalid enumeration entry. Check peak_gfa_module. Check for the symbolicValue of enumerationEntry to match the integerValue.

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

Since

1.0

peak_GFA_Enumeration_SetByIntegerValue()

peak_status peak_GFA_Enumeration_SetByIntegerValue	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		int64_t	enumerationEntryIntegerValue )

Set the enumeration feature with the given name by the entries integer value.

Writes the desired enumeration entry value by its symbolic value to the enumeration 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]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntryIntegerValue	The integer value of the enumeration entry to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE enumerationEntryIntegerValue is out of range. Check the range of valid values via peak_GFA_Enumeration_GetList.

PEAK_STATUS_ACCESS_DENIED The enumeration 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 enumerationFeatureName 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).

Since

1.0

peak_GFA_Enumeration_SetBySymbolicValue()

peak_status peak_GFA_Enumeration_SetBySymbolicValue	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		const char *	enumerationEntrySymbolicValue )

Set the enumeration feature with the given name by the entries symbolic value.

Writes the desired enumeration entry value by its symbolic value to the enumeration 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]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntrySymbolicValue	The symbolic value of the enumeration entry to set as a zero-terminated string.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE enumerationEntrySymbolicValue is out of range. Check the range of valid values via peak_GFA_Enumeration_GetList.

PEAK_STATUS_ACCESS_DENIED The enumeration 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 enumerationFeatureName and/or enumerationEntrySymbolicValue are invalid pointers or 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).

Since

1.0

peak_GFA_EnumerationEntry_GetAccessStatus()

peak_access_status peak_GFA_EnumerationEntry_GetAccessStatus	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		const peak_gfa_enumeration_entry *	enumerationEntry )

Query the access status of the enumeration entry.

Provides the current access status of the specified enumeration entry.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntry	The enumeration entry.

Returns

PEAK_ACCESS_READWRITE The enumeration entry is accessible.

PEAK_ACCESS_NONE The enumeration entry is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The enumeration entry is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_ACCESS_DENIED The enumeration feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.
• PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or enumerationFeatureName and/or enumerationEntry are invalid pointers or enumerationFeatureName is not zero-terminated or enumerationEntry is an invalid enumeration entry. Check peak_gfa_module. Check for the symbolicValue of enumerationEntry to match the integerValue.
• 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).

Since

1.0

peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue()

peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusByIntegerValue	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		int64_t	enumerationEntryIntegerValue )

Query the access status of the enumeration entry by its integer value.

Provides the current access status of the enumeration entry that is specified by it's integer value.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntryIntegerValue	The integer value of the enumeration entry.

Returns

PEAK_ACCESS_READWRITE The enumeration entry is accessible.

PEAK_ACCESS_NONE The enumeration entry is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The enumeration entry is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_ACCESS_DENIED The enumeration feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.
• PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or enumerationFeatureName 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).

Since

1.0

peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue()

peak_access_status peak_GFA_EnumerationEntry_GetAccessStatusBySymbolicValue	(	peak_camera_handle	hCam,
		peak_gfa_module	module,
		const char *	enumerationFeatureName,
		const char *	enumerationEntrySymbolicValue )

Query the access status of the enumeration entry by its symbolic value.

Provides the current access status of the enumeration entry that is specified by its symbolic value.

This function implements the Access Status Query principle.

Parameters

[in]	hCam	The camera handle.
[in]	module	The addressed module.
[in]	enumerationFeatureName	The name of the enumeration feature as a zero-terminated string.
[in]	enumerationEntrySymbolicValue	The symbolic value of the enumeration entry as a zero-terminated string.

Returns

PEAK_ACCESS_READWRITE The enumeration entry is accessible.

PEAK_ACCESS_NONE The enumeration entry is not accessible.

PEAK_ACCESS_NOT_SUPPORTED The enumeration entry is not supported.

PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

• PEAK_STATUS_ACCESS_DENIED The enumeration feature is not accessible. Check the access status via peak_GFA_Feature_GetAccessStatus.
• PEAK_STATUS_INVALID_PARAMETER module is an invalid GFA module or enumerationFeatureName and/or enumerationEntrySymbolicValue are invalid pointers or 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).

Since

1.0