Back to Adaptive Vision Library website

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



Writes named parameter value using GenICam IFloat interface.


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


Name Type Default 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.
inValue double New value that should be written to parameter.
inVerify bool true True to verify parameter access and value range.


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.

Set inVerify argument to true to check new value range 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 IFloat interface.
  • Connection with device is lost.
  • Other unexpected GenICam or connection error occurred.