You are here: Start » Function Reference » GenApi » GenApi_GetEnumParam

GenApi_GetEnumParam

Header:	Genicam.h
Namespace:	fil
Module:	Genicam

Reads named parameter value using GenICam IEnumeration interface.

Syntax

void fil::GenApi_GetEnumParam
(
	GenApiHandle inHandle,
	const char* inParameterName,
	bool inVerifyAccess,
	ftl::String& outValue
)

Parameters

Name	Type	Description
inHandle	GenApiHandle	Handle to object providing GenApi interface.
inParameterName	const char*	Textual name of the parameter that should be accessed in GenICam naming convention or device specific name. Parameter name is case sensitive.
inVerifyAccess	bool	True to verify parameter access.
outValue	String&

Description

This function accesses the configuration of a device or software module using the GenICam GenApi interface. The actual GenApi interface is accessed through the handle of opened device or software module provided by other subsystem (like opened GigEVision device handle). A call to this function may result in time expensive (blocking) data exchange with device.

The returned value is a textual id of the currently selected enumeration entry.

Set inVerifyAccess argument to true to check parameter state. When this argument is false accessing parameter in an improper device state may silently fail, the result is undefined.

Refer to device documentation or use the Device Manager to find proper parameter name.

Exceptions

This function will throw an exception in the following situations:

Object handle is invalid or does not provide the GenApi interface.
GenApi description does not provide a parameter with specified name.
Named parameter does not provide the IEnumeration interface.
Connection with device is lost.
Other unexpected GenICam or connection error occurred.