Back to Aurora Vision Library website

You are here: Start » Function Reference » GenTL » GenTL_GetPixelFormats


Header: Genicam.h
Namespace: avl
Module: Genicam

Retrieves a list of available pixel formats supported by opened device.


void avl::GenTL_GetPixelFormats
	GenTLHandle inDeviceHandle,
	atl::Array< atl::String >& outFormats


Name Type Default Description
Input value
inDeviceHandle GenTLHandle Handle of an opened device.
Output value
outFormats ArrayString >& Array that will return a list of format strings.


This function accesses GenICam "PixelFormat" standard enumeration parameter and reads its entries. Only entries marked as implemented and available will be present in the returned list. The list will contain names of PixelFormat enumeration entries (not display names).

One of the format names returned by this function can be passed to GenTL_StartAcquisition function.


This function will throw an exception in the following situations:

  • Device handle is invalid.
  • Connection with device is lost.
  • Device is not a video transmitter.
  • Other general GenTL or GenICam error occurred.