Back to FabImage Library website

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

GenApi_GetParamDescriptor


Header: Genicam.h
Namespace: fil
Module: Genicam

Reads named parameter description and attributes from GenICam interface.

Syntax

C++
C#
 
void fil::GenApi_GetParamDescriptor
(
	GenApiHandle inHandle,
	const char* inParameterName,
	GenApi_ParameterDescriptor& outDescriptor
)

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.
Output value
 outDescriptor GenApi_ParameterDescriptor&

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.

This function can be used to obtain additional information, meta data and the state of a GenICam parameter. The information is returned using GenApi_ParameterDescriptor structure.

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.
  • Connection with device is lost.
  • Other unexpected GenICam or connection error occurred.