Back to Aurora Vision Library website

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


Header: Genicam.h
Namespace: avl
Module: Genicam

Writes named parameter value using GenICam IEnumeration interface.


void avl::GenApi_SetEnumParam
	GenApiHandle inHandle,
	const char* inParameterName,
	const char* inValue,
	bool inVerify = true


Name Type Default Description
Input value inHandle GenApiHandle Handle to object providing GenApi interface.
Input value 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.
Input value inValue const char* New enumeration entry id that should be written to parameter.
Input value inVerify bool true True to verify parameter access and value range and alignment.


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 new value must be specified as a textual id of one of enumeration entries.

Set inVerify argument to true to check new value range, increment and parameter state. When this argument is set to false writing invalid value or accessing parameter in an improper device state will silently fail, the results on device side are undefined.

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


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.
  • Enumeration value does not exist in parameter.
  • Connection with device is lost.
  • Other unexpected GenICam or connection error occurred.