Back to FabImage Library website

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

GenApi_GetEnumDescriptor


Header: Genicam.h
Namespace: fil
Module: Genicam

Reads named enum parameter description from GenICam IEnumeration interface.

Syntax

C++
C#
 
void fil::GenApi_GetEnumDescriptor
(
	GenApiHandle inHandle,
	const char* inParameterName,
	bool inAvailableEntriesOnly,
	GenApi_EnumDescriptor& 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.
Input value inAvailableEntriesOnly bool True to include in returned description only implemented and available enumeration entries.
Output value outDescriptor GenApi_EnumDescriptor&

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 the description of named Enumeration parameter with the list of enumeration entries. The information is returned using GenApi_EnumDescriptor 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.
  • Named parameter does not provide the IEnumeration interface.
  • Connection with device is lost.
  • Other unexpected GenICam or connection error occurred.