Back to Aurora Vision Library website
You are here: Start » Function Reference » GigE Vision » GigEVision_GetPixelFormats
GigEVision_GetPixelFormats
| Header: | Genicam.h |
|---|---|
| Namespace: | avl |
| Module: | Genicam |
Retrieves a list of available pixel formats supported by opened device.
Syntax
C++
C#
void avl::GigEVision_GetPixelFormats
(
GigEHandle inDeviceHandle,
atl::Array< atl::String >& outFormats
)
Parameters
| Name | Type | Default | Description | |
|---|---|---|---|---|
 |
inDeviceHandle | GigEHandle | Handle of an opened device. | |
 |
outFormats | Array< String >& | Array that will return a list of format strings. |
Description
This function will access GenICam "PixelFormat" standard enumeration parameter and read 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 GigEVision_StartAcquisition function.
Exceptions
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 unexpected GenICam or connection error occurred.
