Back to Aurora Vision Library website

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


Header: Genicam.h
Namespace: avl
Module: Genicam

Reads named category description from GenICam interface.


void avl::GenApi_GetCategoryDescriptor
	GenApiHandle inHandle,
	const char* inCategoryName,
	GenApi_CategoryDescriptor& outDescriptor


Name Type Default Description
Input value inHandle GenApiHandle Handle to object providing GenApi interface.
Input value inCategoryName const char* Textual name of the category that should be accessed in GenICam naming convention or device specific name. Category name is case sensitive.
Output value outDescriptor GenApi_CategoryDescriptor&


This function accesses the configuration of a device or a 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).

Categories are special types of GenApi nodes not associated with a parameter value. Instead, a category contains a list of other parameters or categories, forming a tree structure of top level parameters. Categories' trees are usable for creating user interface. The main category of every GenApi set is named "Root".

This function can be used to obtain description of named Category. Information is returned using GenApi_CategoryDescriptor structure.


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 category with specified name.
  • Named parameter does not provide the ICategory interface.