Back to FabImage Library website

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

GenApi_GetIntegerParam


Header: Genicam.h
Namespace: fil
Module: Genicam

Reads named parameter value using GenICam IInteger interface.

Syntax

C++
C#
 
ftl::sint64 fil::GenApi_GetIntegerParam
(
	GenApiHandle inHandle,
	const char* inParameterName,
	bool inVerifyAccess = true
)

Parameters

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
 inVerifyAccess bool true True to verify parameter access.

Description

This function accesses the configuration of a device or software module using 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 inVerifyAccess argument to true to check parameter state. When this argument is set to false accessing parameter in an improper device state may silently fail, the result is undefined.

Refer to device documentation or use 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 IInteger interface.
  • Connection with device is lost.
  • Other unexpected GenICam or connection error occurred.