All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
pylon Interface

Data Structures

struct  PylonDeviceInfo_t
 Device info struct. More...
 
struct  PylonEventResult_t
 Result data struct for PylonEventGrabberRetrieveEvent(). More...
 
struct  PylonGigEActionCommandResult_t
 Optional result structure of IGigETransportLayer::IssueActionCommand and IGigETransportLayer::IssueScheduledActionCommand. More...
 
struct  PylonGrabResult_t
 Result data struct for PylonStreamGrabberRetrieveResult(). This data describes grab results (typically image data) retrieved from the device. Some items are optional (marked as "optional") and are only filled in if they are supported by the device. More...
 
struct  PylonImagePersistenceOptions_t
 Holds the image persistence options. More...
 

Macros

#define PYLON_MAX_DEVICEINFO_ENTRY_LENGTH   64
 Fixed string size for PylonDeviceInfo_t members.
 

Typedefs

typedef struct
PYLON_CHUNKPARSER_HANDLE_ * 
PYLON_CHUNKPARSER_HANDLE
 A handle for a chunk parser object.
 
typedef struct
PYLON_DEVICE_HANDLE_ * 
PYLON_DEVICE_HANDLE
 A handle for a device object.
 
typedef struct
PYLON_DEVICE_INFO_HANDLE_ * 
PYLON_DEVICE_INFO_HANDLE
 A handle for a device info object.
 
typedef struct
PYLON_DEVICECALLBACK_HANDLE_ * 
PYLON_DEVICECALLBACK_HANDLE
 A handle for a device callback object.
 
typedef struct
PYLON_EVENTADAPTER_HANDLE_ * 
PYLON_EVENTADAPTER_HANDLE
 A handle for an event adapter object.
 
typedef struct
PYLON_EVENTGRABBER_HANDLE_ * 
PYLON_EVENTGRABBER_HANDLE
 A handle for an event grabber object.
 
typedef struct
PYLON_FORMAT_CONVERTER_HANDLE_ * 
PYLON_FORMAT_CONVERTER_HANDLE
 A handle for a pixel format converter object.
 
typedef struct
PYLON_IMAGE_FORMAT_CONVERTER_HANDLE_ * 
PYLON_IMAGE_FORMAT_CONVERTER_HANDLE
 A handle for a pixel format converter object.
 
typedef struct
PYLON_STREAMBUFFER_HANDLE_ * 
PYLON_STREAMBUFFER_HANDLE
 A handle for a stream buffer object.
 
typedef struct
PYLON_STREAMGRABBER_HANDLE_ * 
PYLON_STREAMGRABBER_HANDLE
 A handle for a stream grabber object.
 
typedef struct
PYLON_WAITOBJECT_HANDLE_ * 
PYLON_WAITOBJECT_HANDLE
 A handle for a wait object.
 
typedef struct
PYLON_WAITOBJECTS_HANDLE_ * 
PYLON_WAITOBJECTS_HANDLE
 A handle for a node object set.
 
typedef void PylonDeviceRemCb_t (PYLON_DEVICE_HANDLE h)
 pylon device removal callback handler type.
 

Enumerations

enum  EPylonGigEActionCommandStatus { PylonGigEActionCommandStatus_Ok = 0, PylonGigEActionCommandStatus_NoRefTime = -519995373, PylonGigEActionCommandStatus_Overflow = -519995371, PylonGigEActionCommandStatus_ActionLate = -519995370 }
 Lists possible status codes returned by PylonGigEIssueActionCommand() or PylonGigEIssueScheduledActionCommand(). More...
 
enum  EPylonGrabStatus {
  UndefinedGrabStatus = -1, Idle, Queued, Grabbed,
  Canceled, Failed
}
 The grab status. More...
 
enum  EPylonImageFileFormat { ImageFileFormat_Tiff = 1, ImageFileFormat_Png = 3 }
 Lists the available file formats. More...
 
enum  EPylonImageOrientation { ImageOrientation_TopDown, ImageOrientation_BottomUp }
 Defines the vertical orientation of an image in memory. More...
 
enum  EPylonPayloadType {
  PayloadType_Undefined = -1, PayloadType_Image, PayloadType_RawData, PayloadType_File,
  PayloadType_ChunkData, PayloadType_DeviceSpecific = 0x8000
}
 PayloadType for PylonGrabResult_t. More...
 
enum  EPylonPixelType {
  PixelType_Undefined = -1, PixelType_Mono8 = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x0001, PixelType_Mono8signed = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x0002, PixelType_Mono10 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0003,
  PixelType_Mono10packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0004, PixelType_Mono10p = PIXEL_MONO | PIXEL_BIT_COUNT(10) | 0x0046, PixelType_Mono12 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0005, PixelType_Mono12packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0006,
  PixelType_Mono12p = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0047, PixelType_Mono16 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0007, PixelType_BayerGR8 = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x0008, PixelType_BayerRG8 = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x0009,
  PixelType_BayerGB8 = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x000a, PixelType_BayerBG8 = PIXEL_MONO | PIXEL_BIT_COUNT(8) | 0x000b, PixelType_BayerGR10 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x000c, PixelType_BayerRG10 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x000d,
  PixelType_BayerGB10 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x000e, PixelType_BayerBG10 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x000f, PixelType_BayerGR12 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0010, PixelType_BayerRG12 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0011,
  PixelType_BayerGB12 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0012, PixelType_BayerBG12 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0013, PixelType_RGB8packed = PIXEL_COLOR | PIXEL_BIT_COUNT(24) | 0x0014, PixelType_BGR8packed = PIXEL_COLOR | PIXEL_BIT_COUNT(24) | 0x0015,
  PixelType_RGBA8packed = PIXEL_COLOR | PIXEL_BIT_COUNT(32) | 0x0016, PixelType_BGRA8packed = PIXEL_COLOR | PIXEL_BIT_COUNT(32) | 0x0017, PixelType_RGB10packed = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0018, PixelType_BGR10packed = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0019,
  PixelType_RGB12packed = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x001a, PixelType_BGR12packed = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x001b, PixelType_RGB16packed = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0033, PixelType_BGR10V1packed = PIXEL_COLOR | PIXEL_BIT_COUNT(32) | 0x001c,
  PixelType_BGR10V2packed = PIXEL_COLOR | PIXEL_BIT_COUNT(32) | 0x001d, PixelType_YUV411packed = PIXEL_COLOR | PIXEL_BIT_COUNT(12) | 0x001e, PixelType_YUV422packed = PIXEL_COLOR | PIXEL_BIT_COUNT(16) | 0x001f, PixelType_YUV444packed = PIXEL_COLOR | PIXEL_BIT_COUNT(24) | 0x0020,
  PixelType_RGB8planar = PIXEL_COLOR | PIXEL_BIT_COUNT(24) | 0x0021, PixelType_RGB10planar = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0022, PixelType_RGB12planar = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0023, PixelType_RGB16planar = PIXEL_COLOR | PIXEL_BIT_COUNT(48) | 0x0024,
  PixelType_YUV422_YUYV_Packed = PIXEL_COLOR | PIXEL_BIT_COUNT(16) | 0x0032, PixelType_BayerGR12Packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x002A, PixelType_BayerRG12Packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x002B, PixelType_BayerGB12Packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x002C,
  PixelType_BayerBG12Packed = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x002D, PixelType_BayerGR10p = PIXEL_MONO | PIXEL_BIT_COUNT(10) | 0x0056, PixelType_BayerRG10p = PIXEL_MONO | PIXEL_BIT_COUNT(10) | 0x0058, PixelType_BayerGB10p = PIXEL_MONO | PIXEL_BIT_COUNT(10) | 0x0054,
  PixelType_BayerBG10p = PIXEL_MONO | PIXEL_BIT_COUNT(10) | 0x0052, PixelType_BayerGR12p = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0057, PixelType_BayerRG12p = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0059, PixelType_BayerGB12p = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0055,
  PixelType_BayerBG12p = PIXEL_MONO | PIXEL_BIT_COUNT(12) | 0x0053, PixelType_BayerGR16 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x002E, PixelType_BayerRG16 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x002F, PixelType_BayerGB16 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0030,
  PixelType_BayerBG16 = PIXEL_MONO | PIXEL_BIT_COUNT(16) | 0x0031, PixelType_RGB12V1packed = PIXEL_COLOR | PIXEL_BIT_COUNT(36) | 0X0034, PixelType_Double = 0x80000000 | PIXEL_MONO | PIXEL_BIT_COUNT(48) | 0x100
}
 List all possible pixel formats. See the camera User's Manual for a detailed description of the available pixel formats. More...
 
enum  EPylonWaitExResult { waitex_timeout = 0, waitex_signaled = 1, waitex_abandoned = 2, waitex_alerted = -1 }
 The reason why a wait operation terminated. More...
 

Functions

GENAPIC_RESULT PylonBitsPerPixel (EPylonPixelType pixelType, int *pResult)
 Return the number of bits per pixel for a pixel type. More...
 
GENAPIC_RESULT PylonChunkParserAttachBuffer (PYLON_CHUNKPARSER_HANDLE hChp, const void *pBuffer, size_t BufLen)
 Attach a data buffer to a chunk parser. More...
 
GENAPIC_RESULT PylonChunkParserCheckCRC (PYLON_CHUNKPARSER_HANDLE hChp, _Bool *pResult)
 Return true if CRC checksum chunk data is valid. More...
 
GENAPIC_RESULT PylonChunkParserDetachBuffer (PYLON_CHUNKPARSER_HANDLE hChp)
 Detach a data buffer from a chunk parser. More...
 
GENAPIC_RESULT PylonChunkParserHasCRC (PYLON_CHUNKPARSER_HANDLE hChp, _Bool *pResult)
 Return true if CRC checksum chunk data is present. More...
 
GENAPIC_RESULT PylonChunkParserUpdateBuffer (PYLON_CHUNKPARSER_HANDLE hChp, const void *pBuffer)
 Replace a data buffer attached to a chunk parser. More...
 
GENAPIC_RESULT PylonCreateDeviceByIndex (size_t index, PYLON_DEVICE_HANDLE *phDev)
 Create a device object. More...
 
GENAPIC_RESULT PylonDestroyDevice (PYLON_DEVICE_HANDLE hDev)
 Delete a device object. More...
 
GENAPIC_RESULT PylonDeviceAccessMode (PYLON_DEVICE_HANDLE hDev, int *pAccessMode)
 Return access mode flags for a device. More...
 
GENAPIC_RESULT PylonDeviceClose (PYLON_DEVICE_HANDLE hDev)
 Close a device. More...
 
GENAPIC_RESULT PylonDeviceCreateChunkParser (PYLON_DEVICE_HANDLE hDev, PYLON_CHUNKPARSER_HANDLE *phChp)
 Create a chunk parser for a device. More...
 
GENAPIC_RESULT PylonDeviceCreateEventAdapter (PYLON_DEVICE_HANDLE hDev, PYLON_EVENTADAPTER_HANDLE *phEva)
 Create an event adapter for a device. More...
 
GENAPIC_RESULT PylonDeviceDeregisterRemovalCallback (PYLON_DEVICE_HANDLE hDev, PYLON_DEVICECALLBACK_HANDLE hCb)
 Unregister device removal callback. More...
 
GENAPIC_RESULT PylonDeviceDestroyChunkParser (PYLON_DEVICE_HANDLE hDev, PYLON_CHUNKPARSER_HANDLE hChp)
 Destroy a chunk parser. More...
 
GENAPIC_RESULT PylonDeviceDestroyEventAdapter (PYLON_DEVICE_HANDLE hDev, PYLON_EVENTADAPTER_HANDLE hEva)
 Destroy an event adapter. More...
 
GENAPIC_RESULT PylonDeviceExecuteCommandFeature (PYLON_DEVICE_HANDLE hDev, const char *pName)
 Execute a command. More...
 
GENAPIC_RESULT PylonDeviceFeatureFromString (PYLON_DEVICE_HANDLE hDev, const char *pName, const char *pValue)
 Set a feature's value from a string. More...
 
GENAPIC_RESULT PylonDeviceFeatureGetAccessMode (PYLON_DEVICE_HANDLE hDev, const char *pName, EGenApiAccessMode *pResult)
 Return a feature's access permissions. More...
 
_Bool PylonDeviceFeatureIsAvailable (PYLON_DEVICE_HANDLE hDev, const char *pName)
 Return boolean 'available' status for feature. More...
 
_Bool PylonDeviceFeatureIsImplemented (PYLON_DEVICE_HANDLE hDev, const char *pName)
 Return boolean 'implemented' status for feature. More...
 
_Bool PylonDeviceFeatureIsReadable (PYLON_DEVICE_HANDLE hDev, const char *pName)
 Return boolean 'readable' status for feature. More...
 
_Bool PylonDeviceFeatureIsWritable (PYLON_DEVICE_HANDLE hDev, const char *pName)
 Return boolean 'writable' status for feature. More...
 
GENAPIC_RESULT PylonDeviceFeatureToString (PYLON_DEVICE_HANDLE hDev, const char *pName, char *pBuf, size_t *pBufLen)
 Return a feature's value as a string. More...
 
GENAPIC_RESULT PylonDeviceGetBooleanFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, _Bool *pValue)
 Return a boolean feature's value. More...
 
GENAPIC_RESULT PylonDeviceGetDeviceInfo (PYLON_DEVICE_HANDLE hDev, PylonDeviceInfo_t *pDeviceInfo)
 Get device information from device. More...
 
GENAPIC_RESULT PylonDeviceGetDeviceInfoHandle (PYLON_DEVICE_HANDLE hDev, PYLON_DEVICE_INFO_HANDLE *phDi)
 Return the handle to the device info object from which a device was created. More...
 
GENAPIC_RESULT PylonDeviceGetEventGrabber (PYLON_DEVICE_HANDLE hDev, PYLON_EVENTGRABBER_HANDLE *phEvg)
 Obtain an event grabber handle from a device. More...
 
GENAPIC_RESULT PylonDeviceGetFloatFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, double *pValue)
 Return a float feature's value. More...
 
GENAPIC_RESULT PylonDeviceGetFloatFeatureMax (PYLON_DEVICE_HANDLE hDev, const char *pName, double *pValue)
 Return a float feature's maximum value. More...
 
GENAPIC_RESULT PylonDeviceGetFloatFeatureMin (PYLON_DEVICE_HANDLE hDev, const char *pName, double *pValue)
 Return a float feature's minimum value. More...
 
GENAPIC_RESULT PylonDeviceGetIntegerFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, int64_t *pValue)
 Return an integer feature's value. More...
 
GENAPIC_RESULT PylonDeviceGetIntegerFeatureInc (PYLON_DEVICE_HANDLE hDev, const char *pName, int64_t *pValue)
 Return an integer feature's increment value. More...
 
GENAPIC_RESULT PylonDeviceGetIntegerFeatureMax (PYLON_DEVICE_HANDLE hDev, const char *pName, int64_t *pValue)
 Return an integer feature's maximum value. More...
 
GENAPIC_RESULT PylonDeviceGetIntegerFeatureMin (PYLON_DEVICE_HANDLE hDev, const char *pName, int64_t *pValue)
 Return an integer feature's minimum value. More...
 
GENAPIC_RESULT PylonDeviceGetNodeMap (PYLON_DEVICE_HANDLE hDev, NODEMAP_HANDLE *phMap)
 Return the parameter node map for a device. More...
 
GENAPIC_RESULT PylonDeviceGetNumStreamGrabberChannels (PYLON_DEVICE_HANDLE hDev, size_t *pNumChannels)
 Return the number of stream grabber channels for a device. More...
 
GENAPIC_RESULT PylonDeviceGetStreamGrabber (PYLON_DEVICE_HANDLE hDev, size_t index, PYLON_STREAMGRABBER_HANDLE *phStg)
 Obtain a stream grabber handle from a device. More...
 
GENAPIC_RESULT PylonDeviceGetTLNodeMap (PYLON_DEVICE_HANDLE hDev, NODEMAP_HANDLE *phMap)
 Obtain a transport layer parameter node map from a device. More...
 
GENAPIC_RESULT PylonDeviceGrabSingleFrame (PYLON_DEVICE_HANDLE hDev, size_t channel, void *pBuffer, size_t bufferSize, PylonGrabResult_t *pGrabResult, _Bool *pReady, uint32_t timeout)
 Set the acquision mode to 'single frame' and grab one image. More...
 
GENAPIC_RESULT PylonDeviceInfoGetNumProperties (PYLON_DEVICE_INFO_HANDLE hDi, size_t *numProperties)
 Return the number of properties stored in a device info object. More...
 
GENAPIC_RESULT PylonDeviceInfoGetPropertyName (PYLON_DEVICE_INFO_HANDLE hDi, size_t index, char *pBuf, size_t *pBufLen)
 Return the name of a device property identified by its index. More...
 
GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByIndex (PYLON_DEVICE_INFO_HANDLE hDi, size_t index, char *pBuf, size_t *pBufLen)
 Return the value of a device property identified by its index. More...
 
GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByName (PYLON_DEVICE_INFO_HANDLE hDi, const char *pName, char *pBuf, size_t *pBufLen)
 Return the value of a device property identified by its name. More...
 
GENAPIC_RESULT PylonDeviceIsCommandDone (PYLON_DEVICE_HANDLE hDev, const char *pName, _Bool *pResult)
 Return true if command execution has finished. More...
 
GENAPIC_RESULT PylonDeviceIsOpen (PYLON_DEVICE_HANDLE hDev, _Bool *pOpen)
 Return device open status. More...
 
GENAPIC_RESULT PylonDeviceOpen (PYLON_DEVICE_HANDLE hDev, int accessMode)
 Open a device. More...
 
GENAPIC_RESULT PylonDevicePortRead (PYLON_DEVICE_HANDLE hDev, void *pBuffer, int64_t Address, size_t Length)
 Perform a raw read on the standard "Device"-node port. More...
 
GENAPIC_RESULT PylonDevicePortWrite (PYLON_DEVICE_HANDLE hDev, const void *pBuffer, int64_t Address, size_t Length)
 Perform a raw write on the standard "Device"-node port. More...
 
GENAPIC_RESULT PylonDeviceRegisterRemovalCallback (PYLON_DEVICE_HANDLE hDev, PylonDeviceRemCb_t *pCbFunction, PYLON_DEVICECALLBACK_HANDLE *phCb)
 Register device removal callback. More...
 
GENAPIC_RESULT PylonDeviceSetBooleanFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, _Bool value)
 Set a boolean feature's value. More...
 
GENAPIC_RESULT PylonDeviceSetFloatFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, double value)
 Set a float feature's value. More...
 
GENAPIC_RESULT PylonDeviceSetIntegerFeature (PYLON_DEVICE_HANDLE hDev, const char *pName, int64_t value)
 Set an integer feature's value. More...
 
GENAPIC_RESULT PylonEnumerateDevices (size_t *numDevices)
 Enumerate all camera devices. More...
 
GENAPIC_RESULT PylonEventAdapterDeliverMessage (PYLON_EVENTADAPTER_HANDLE hEva, const PylonEventResult_t *pEventResult)
 Process event messages. More...
 
GENAPIC_RESULT PylonEventGrabberClose (PYLON_EVENTGRABBER_HANDLE hEvg)
 Close an event grabber. More...
 
GENAPIC_RESULT PylonEventGrabberGetNodeMap (PYLON_EVENTGRABBER_HANDLE hEvg, NODEMAP_HANDLE *phMap)
 Return an event grabber's parameter node map. More...
 
GENAPIC_RESULT PylonEventGrabberGetNumBuffers (PYLON_EVENTGRABBER_HANDLE hEvg, size_t *pNumBuffers)
 Return the number of event buffers used by an event grabber. More...
 
GENAPIC_RESULT PylonEventGrabberGetWaitObject (PYLON_EVENTGRABBER_HANDLE hEvg, PYLON_WAITOBJECT_HANDLE *phWobj)
 Return an event grabber's wait object. More...
 
GENAPIC_RESULT PylonEventGrabberIsOpen (PYLON_EVENTGRABBER_HANDLE hEvg, _Bool *pOpen)
 Return an event grabber's boolean 'open' status. More...
 
GENAPIC_RESULT PylonEventGrabberOpen (PYLON_EVENTGRABBER_HANDLE hEvg)
 Open an event grabber. More...
 
GENAPIC_RESULT PylonEventGrabberRetrieveEvent (PYLON_EVENTGRABBER_HANDLE hEvg, PylonEventResult_t *pEventResult, _Bool *pReady)
 Retrieve an event from an event grabber. More...
 
GENAPIC_RESULT PylonEventGrabberSetNumBuffers (PYLON_EVENTGRABBER_HANDLE hEvg, size_t numBuffers)
 Set the number of event buffers used by an event grabber. More...
 
GENAPIC_RESULT PylonFeaturePersistenceLoad (NODEMAP_HANDLE hMap, const char *pFileName, _Bool verify)
 Loads the features from a file and stores it to the node tree. More...
 
GENAPIC_RESULT PylonFeaturePersistenceLoadFromString (NODEMAP_HANDLE hMap, const char *pFeatures, _Bool verify)
 Loads the features from a string and stores it to the node tree. More...
 
GENAPIC_RESULT PylonFeaturePersistenceSave (NODEMAP_HANDLE hMap, const char *pFileName)
 Saves the node tree to a file. More...
 
GENAPIC_RESULT PylonFeaturePersistenceSaveToString (NODEMAP_HANDLE hMap, char *pFeatures, size_t *pFeaturesLen)
 Saves the node tree to a string. More...
 
GENAPIC_RESULT PylonGetDeviceInfo (size_t index, PylonDeviceInfo_t *pDi)
 Get information about camera device identified by its index. More...
 
GENAPIC_RESULT PylonGetDeviceInfoHandle (size_t index, PYLON_DEVICE_INFO_HANDLE *phDi)
 Return a handle for a camera device info object. More...
 
GENAPIC_RESULT PylonGigEAnnounceRemoteDevice (const char *pIpAddress)
 Announce that a remote device is going to be used. More...
 
GENAPIC_RESULT PylonGigEBroadcastIpConfiguration (const char *pMacAddress, _Bool EnablePersistentIp, _Bool EnableDHCP, const char *pIpAddress, const char *pSubnetMask, const char *pDefaultGateway, const char *pUserdefinedName, _Bool *pRetval)
 Broadcasts the IP configuration. More...
 
GENAPIC_RESULT PylonGigEChangeIpConfiguration (PYLON_DEVICE_HANDLE hDev, _Bool EnablePersistentIp, _Bool EnableDhcp)
 Enables/disables use of a persistent IP address and DHCP usage. More...
 
GENAPIC_RESULT PylonGigEEnumerateAllDevices (size_t *numDevices)
 Enumerate all GigE camera devices in all subnets. More...
 
GENAPIC_RESULT PylonGigEForceIp (const char *pMacAddress, const char *pIpAddress, const char *pSubnetMask, const char *pDefaultGateway)
 'Force' a static IP address configuration into a device identified by its MAC Address. More...
 
GENAPIC_RESULT PylonGigEGetPersistentIpAddress (PYLON_DEVICE_HANDLE hDev, char *pIpAddress, size_t *pIpAddressLen, char *pSubnetMask, size_t *pSubnetMaskLen, char *pDefaultGateway, size_t *pDefaultGatewayLen)
 Reads the persistent IP address from the device. More...
 
GENAPIC_RESULT PylonGigEIssueActionCommand (uint32_t deviceKey, uint32_t groupKey, uint32_t groupMask, const char *pBroadcastAddress, uint32_t timeoutMs, uint32_t *pNumResults, PylonGigEActionCommandResult_t *pResults)
 Issue an action command via broadcast. More...
 
GENAPIC_RESULT PylonGigEIssueScheduledActionCommand (uint32_t deviceKey, uint32_t groupKey, uint32_t groupMask, uint64_t actionTimeNs, const char *pBroadcastAddress, uint32_t timeoutMs, uint32_t *pNumResults, PylonGigEActionCommandResult_t *pResults)
 Issue a scheduled action command via broadcast. More...
 
GENAPIC_RESULT PylonGigERenounceRemoteDevice (const char *pIpAddress, _Bool *pFound)
 Stop using remote device. More...
 
GENAPIC_RESULT PylonGigERestartIpConfiguration (const char *pMacAddress)
 Let a device restart the IP configuration cycle. More...
 
GENAPIC_RESULT PylonGigESetPersistentIpAddress (PYLON_DEVICE_HANDLE hDev, const char *pIpAddress, const char *pSubnetMask, const char *pDefaultGateway)
 Writes a persistent IP address to the device. More...
 
GENAPIC_RESULT PylonImageFormatConverterConvert (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, void *targetBuffer, size_t targetBufferSize, const void *sourceBuffer, size_t sourceBufferSize, EPylonPixelType sourcePixelType, uint32_t sourceWidth, uint32_t sourceHeight, size_t sourcePaddingX, EPylonImageOrientation sourceOrientation)
 Converts an image. More...
 
GENAPIC_RESULT PylonImageFormatConverterCreate (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE *phConv)
 Creates an image format converter. More...
 
GENAPIC_RESULT PylonImageFormatConverterDestroy (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv)
 Destroys an image format converter. More...
 
GENAPIC_RESULT PylonImageFormatConverterGetBufferSizeForConversion (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, EPylonPixelType sourcePixelType, uint32_t sourceWidth, uint32_t sourceHeight, size_t *pBufSize)
 Gets the buffer size for a converted image. More...
 
GENAPIC_RESULT PylonImageFormatConverterGetNodeMap (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, NODEMAP_HANDLE *phMap)
 Gets the handle for node map of an image format converter. More...
 
GENAPIC_RESULT PylonImageFormatConverterGetOutputPaddingX (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, size_t *pPaddingX)
 Gets the padding, i. e. the number of additional data bytes at the end of each image row. More...
 
GENAPIC_RESULT PylonImageFormatConverterGetOutputPixelFormat (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, EPylonPixelType *pPixelType)
 Gets the output pixel format of an image format converter. More...
 
GENAPIC_RESULT PylonImageFormatConverterSetOutputPaddingX (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, size_t paddingX)
 Sets the padding, i. e. the number of additional data bytes at the end of each image row. More...
 
GENAPIC_RESULT PylonImageFormatConverterSetOutputPixelFormat (PYLON_IMAGE_FORMAT_CONVERTER_HANDLE hConv, EPylonPixelType pixelType)
 Sets the output pixel format of an image format converter. More...
 
GENAPIC_RESULT PylonImagePersistenceLoad (const char *pFilename, void *pBuffer, size_t *pBufferSize, EPylonPixelType *pPixelType, uint32_t *pWidth, uint32_t *pHeight, size_t *pPaddingX, EPylonImageOrientation *pOrientation)
 Loads an image from disk. More...
 
GENAPIC_RESULT PylonImagePersistenceSave (EPylonImageFileFormat imageFileFormat, const char *pFilename, const void *pBuffer, size_t bufferSize, EPylonPixelType pixelType, uint32_t width, uint32_t height, size_t paddingX, EPylonImageOrientation orientation, PylonImagePersistenceOptions_t *pOptions)
 Saves the image to disk. Converts the image to a format that can be saved if required. More...
 
GENAPIC_RESULT PylonInitialize (void)
 Initialize the pylon C runtime system. More...
 
GENAPIC_RESULT PylonIsBayer (EPylonPixelType pixelType, _Bool *pResult)
 Return true if the pixel format is a Bayer format. More...
 
GENAPIC_RESULT PylonIsDeviceAccessible (size_t index, int accessMode, _Bool *pIsAccessible)
 This method can be used to check if a camera device can be created and opened. More...
 
GENAPIC_RESULT PylonIsMono (EPylonPixelType pixelType, _Bool *pResult)
 Return true if pixel format is monochrome. More...
 
GENAPIC_RESULT PylonPixelFormatConverterConvert (PYLON_FORMAT_CONVERTER_HANDLE hConv, void *targetBuffer, size_t targetBufferSize, const void *sourceBuffer, size_t sourceBufferSize)
 Deprecated: Convert pixel data to a different format. More...
 
GENAPIC_RESULT PylonPixelFormatConverterCreate (PYLON_DEVICE_HANDLE hDev, int outAlign, PYLON_FORMAT_CONVERTER_HANDLE *phConv)
 Deprecated: Create a pixel format converter. More...
 
GENAPIC_RESULT PylonPixelFormatConverterDestroy (PYLON_FORMAT_CONVERTER_HANDLE hConv)
 Deprecated: Delete a pixel format converter. More...
 
GENAPIC_RESULT PylonPixelFormatConverterGetOutputBufferSize (PYLON_FORMAT_CONVERTER_HANDLE hConv, size_t *pBufSiz)
 Deprecated: Compute required output buffer size for pixel format converter. More...
 
GENAPIC_RESULT PylonPixelTypeFromString (const char *pString, EPylonPixelType *pPixelType)
 Translate a pixel type name to an enumeration value. More...
 
GENAPIC_RESULT PylonStreamGrabberCancelGrab (PYLON_STREAMGRABBER_HANDLE hStg)
 Cancel grab operation. More...
 
GENAPIC_RESULT PylonStreamGrabberClose (PYLON_STREAMGRABBER_HANDLE hStg)
 Close a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberDeregisterBuffer (PYLON_STREAMGRABBER_HANDLE hStg, PYLON_STREAMBUFFER_HANDLE hBuf)
 Detach an image data buffer from a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberFinishGrab (PYLON_STREAMGRABBER_HANDLE hStg)
 Shut down a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberGetMaxBufferSize (PYLON_STREAMGRABBER_HANDLE hStg, size_t *pMaxSize)
 Return the maximum data buffer size for a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberGetMaxNumBuffer (PYLON_STREAMGRABBER_HANDLE hStg, size_t *pNumBuffers)
 Return the maximum number of data buffers a stream grabber is set to use. More...
 
GENAPIC_RESULT PylonStreamGrabberGetNodeMap (PYLON_STREAMGRABBER_HANDLE hStg, NODEMAP_HANDLE *phMap)
 Return the node map for a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberGetWaitObject (PYLON_STREAMGRABBER_HANDLE hStg, PYLON_WAITOBJECT_HANDLE *phWobj)
 Return a stream grabber's wait object. More...
 
GENAPIC_RESULT PylonStreamGrabberIsOpen (PYLON_STREAMGRABBER_HANDLE hStg, _Bool *pOpen)
 Return the boolean 'open' status of a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberOpen (PYLON_STREAMGRABBER_HANDLE hStg)
 Open a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberPrepareGrab (PYLON_STREAMGRABBER_HANDLE hStg)
 Prepare a stream grabber for grabbing. More...
 
GENAPIC_RESULT PylonStreamGrabberQueueBuffer (PYLON_STREAMGRABBER_HANDLE hStg, PYLON_STREAMBUFFER_HANDLE hBuf, const void *pContext)
 Submit a data buffer to a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberRegisterBuffer (PYLON_STREAMGRABBER_HANDLE hStg, void *pBuffer, size_t BufLen, PYLON_STREAMBUFFER_HANDLE *phBuf)
 Attach an image data buffer to a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberRetrieveResult (PYLON_STREAMGRABBER_HANDLE hStg, PylonGrabResult_t *pGrabResult, _Bool *pReady)
 Retrieve buffer after processing by stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberSetMaxBufferSize (PYLON_STREAMGRABBER_HANDLE hStg, size_t maxSize)
 Set the maximum data buffer size for a stream grabber. More...
 
GENAPIC_RESULT PylonStreamGrabberSetMaxNumBuffer (PYLON_STREAMGRABBER_HANDLE hStg, size_t numBuffers)
 Set the maximum number of data buffers for a stream grabber to use. More...
 
GENAPIC_RESULT PylonTerminate (void)
 Shut down the pylon C runtime system. More...
 
GENAPIC_RESULT PylonWaitObjectCreate (PYLON_WAITOBJECT_HANDLE *phWobj)
 Create a user-controllable wait object. More...
 
GENAPIC_RESULT PylonWaitObjectDestroy (PYLON_WAITOBJECT_HANDLE hWobj)
 Get rid of a user-controllable wait object. More...
 
GENAPIC_RESULT PylonWaitObjectFromFd (int fd, PYLON_WAITOBJECT_HANDLE *phWobj)
 Create a wait object for an existing Linux file descriptor. More...
 
GENAPIC_RESULT PylonWaitObjectGetFd (PYLON_WAITOBJECT_HANDLE hWobj, int *pFd)
 Return the Linux file descriptor of a wait object. More...
 
GENAPIC_RESULT PylonWaitObjectIsValid (PYLON_WAITOBJECT_HANDLE hWobj, _Bool *pValid)
 Return the boolean 'valid' status of a stream grabber. More...
 
GENAPIC_RESULT PylonWaitObjectReset (PYLON_WAITOBJECT_HANDLE hWobj)
 Reset a wait object to the 'not signaled' state. More...
 
GENAPIC_RESULT PylonWaitObjectsAdd (PYLON_WAITOBJECTS_HANDLE hWos, PYLON_WAITOBJECT_HANDLE hWobj, size_t *pIndex)
 Add a single wait object to a wait object set. More...
 
GENAPIC_RESULT PylonWaitObjectsAddMany (PYLON_WAITOBJECTS_HANDLE hWos, size_t numWaitObjects,...)
 Add multiple wait objects to a wait object set. More...
 
GENAPIC_RESULT PylonWaitObjectsCreate (PYLON_WAITOBJECTS_HANDLE *phWos)
 Create a wait object set. More...
 
GENAPIC_RESULT PylonWaitObjectsDestroy (PYLON_WAITOBJECTS_HANDLE hWos)
 Destroy a wait object set. More...
 
GENAPIC_RESULT PylonWaitObjectSignal (PYLON_WAITOBJECT_HANDLE hWobj)
 Set a wait object to the 'signaled' state. More...
 
GENAPIC_RESULT PylonWaitObjectsRemoveAll (PYLON_WAITOBJECTS_HANDLE hWos)
 Remove all wait objects from a wait object set. More...
 
GENAPIC_RESULT PylonWaitObjectsWaitForAll (PYLON_WAITOBJECTS_HANDLE hWos, uint32_t timeout, _Bool *pResult)
 Wait for all objects in a wait object set to become signaled. More...
 
GENAPIC_RESULT PylonWaitObjectsWaitForAllEx (PYLON_WAITOBJECTS_HANDLE hWos, uint32_t timeout, _Bool alertable, EPylonWaitExResult *pWaitResult)
 Wait for all objects in a wait object set to become signaled. More...
 
GENAPIC_RESULT PylonWaitObjectsWaitForAny (PYLON_WAITOBJECTS_HANDLE hWos, uint32_t timeout, size_t *pIndex, _Bool *pResult)
 Wait for any one object in a wait object set to become signaled. More...
 
GENAPIC_RESULT PylonWaitObjectsWaitForAnyEx (PYLON_WAITOBJECTS_HANDLE hWos, uint32_t timeout, size_t *pIndex, _Bool alertable, EPylonWaitExResult *pWaitResult)
 Wait for any one object in a wait object set to become signaled. More...
 
GENAPIC_RESULT PylonWaitObjectWait (PYLON_WAITOBJECT_HANDLE hWobj, uint32_t timeout, _Bool *pResult)
 Wait on a wait object. More...
 
GENAPIC_RESULT PylonWaitObjectWaitEx (PYLON_WAITOBJECT_HANDLE hWobj, uint32_t timeout, _Bool alertable, EPylonWaitExResult *pWaitResult)
 Extended wait on a wait object. More...
 

Detailed Description

Enumeration Type Documentation

Lists possible status codes returned by PylonGigEIssueActionCommand() or PylonGigEIssueScheduledActionCommand().

Enumerator
PylonGigEActionCommandStatus_Ok 

The device acknowledged the command.

PylonGigEActionCommandStatus_NoRefTime 

The device is not synchronized to a master clock to be used as time reference. Typically used when scheduled action commands cannot be scheduled for a future time since the reference time coming from IEEE 1588 is not locked. The action command has been ignored by the device.

PylonGigEActionCommandStatus_Overflow 

Returned when the scheduled action commands queue is full and the device cannot accept the additional request. The action command has been discarded by the device.

PylonGigEActionCommandStatus_ActionLate 

The requested scheduled action command was requested at a point in time that is in the past. If the time tag of the scheduled action command is in the past (relative to the device timestamp), and if it is a valid action command, then the device will execute this action command immediately and return PylonGigEActionCommandStatus_ActionLate. This status code is used as an indicator to the application requesting the action command that a mis-synchronization might have occurred.

The grab status.

Enumerator
UndefinedGrabStatus 

status not defined

Idle 

currently not used

Queued 

in the input queue

Grabbed 

filled with data

Canceled 

request was canceled

Failed 

request failed

Lists the available file formats.

Enumerator
ImageFileFormat_Tiff 

Tagged Image File Format, no compression, supports mono images with more than 8 bit bit depth.

ImageFileFormat_Png 

Portable Network Graphics, lossless data compression.

Defines the vertical orientation of an image in memory.

Enumerator
ImageOrientation_TopDown 

The first row of the image is located at the start of the image buffer. This is the default for images taken by a camera.

ImageOrientation_BottomUp 

The last row of the image is located at the start of the image buffer.

PayloadType for PylonGrabResult_t.

Enumerator
PayloadType_Undefined 

The buffer content is undefined.

PayloadType_Image 

The buffer contains image data.

PayloadType_RawData 

The buffer contains raw data.

PayloadType_File 

The buffer contains file data.

PayloadType_ChunkData 

The buffer contains chunk data.

PayloadType_DeviceSpecific 

The buffer contains device specific data.

List all possible pixel formats. See the camera User's Manual for a detailed description of the available pixel formats.

Enumerator
PixelType_Undefined 

Indicates that the pixel format is undefined or not valid.

PixelType_Mono8 

Indicates the Mono 8 pixel format.

PixelType_Mono8signed 

Indicates the Mono 8 Signed pixel format.

PixelType_Mono10 

Indicates the Mono 10 pixel format.

PixelType_Mono10packed 

Indicates the Mono 10 Packed pixel format. The memory layout of PixelType_Mono10packed and PixelType_Mono10p is different.

PixelType_Mono10p 

Indicates the Mono10p pixel format. The memory layout of PixelType_Mono10packed and PixelType_Mono10p is different.

PixelType_Mono12 

Indicates the Mono 12 pixel format.

PixelType_Mono12packed 

Indicates the Mono 12 Packed pixel format. The memory layout of PixelType_Mono12packed and PixelType_Mono12p is different.

PixelType_Mono12p 

Indicates the Mono12p pixel format. The memory layout of PixelType_Mono12packed and PixelType_Mono12p is different.

PixelType_Mono16 

Indicates the Mono 16 pixel format.

PixelType_BayerGR8 

Indicates the Bayer GR 8 pixel format.

PixelType_BayerRG8 

Indicates the Bayer RG 8 pixel format.

PixelType_BayerGB8 

Indicates the Bayer GB 8 pixel format.

PixelType_BayerBG8 

Indicates the Bayer BG 8 pixel format.

PixelType_BayerGR10 

Indicates the Bayer GR 10 pixel format.

PixelType_BayerRG10 

Indicates the Bayer RG 10 pixel format.

PixelType_BayerGB10 

Indicates the Bayer GB 10 pixel format.

PixelType_BayerBG10 

Indicates the Bayer BG 10 pixel format.

PixelType_BayerGR12 

Indicates the Bayer GR 12 pixel format.

PixelType_BayerRG12 

Indicates the Bayer RG 12 pixel format.

PixelType_BayerGB12 

Indicates the Bayer GB 12 pixel format.

PixelType_BayerBG12 

Indicates the Bayer BG 12 pixel format.

PixelType_RGB8packed 

Indicates the RGB 8 Packed pixel format.

PixelType_BGR8packed 

Indicates the BGR 8 Packed pixel format.

PixelType_RGBA8packed 

Indicates the RGBA 8 Packed pixel format.

PixelType_BGRA8packed 

Indicates the BGRA 8 Packed pixel format.

PixelType_RGB10packed 

Indicates the RGB 10 Packed pixel format.

PixelType_BGR10packed 

Indicates the BGR 10 Packed pixel format.

PixelType_RGB12packed 

Indicates the RGB 12 Packed pixel format.

PixelType_BGR12packed 

Indicates the BGR 12 Packed pixel format.

PixelType_RGB16packed 

Indicates the RGB 16 Packed pixel format.

PixelType_BGR10V1packed 

Indicates the BGR 10 V1 Packed pixel format.

PixelType_BGR10V2packed 

Indicates the BGR 10 V2 Packed pixel format.

PixelType_YUV411packed 

Indicates the YUV 411 Packed pixel format.

PixelType_YUV422packed 

Indicates the YUV 422 Packed pixel format.

PixelType_YUV444packed 

Indicates the YUV 444 Packed pixel format.

PixelType_RGB8planar 

Indicates the RGB 8 Planar pixel format.

PixelType_RGB10planar 

Indicates the RGB 10 Planar pixel format.

PixelType_RGB12planar 

Indicates the RGB 12 Planar pixel format.

PixelType_RGB16planar 

Indicates the RGB 16 Planar pixel format.

PixelType_YUV422_YUYV_Packed 

Indicates the YUV 422 (YUYV) Packed pixel format.

PixelType_BayerGR12Packed 

Indicates the Bayer GR 12 Packed pixel format. The memory layout of PixelType_BayerGR12Packed and PixelType_BayerGR12p is different.

PixelType_BayerRG12Packed 

Indicates the Bayer RG 12 Packed pixel format. The memory layout of PixelType_BayerRG12Packed and PixelType_BayerRG12p is different.

PixelType_BayerGB12Packed 

Indicates the Bayer GB 12 Packed pixel format. The memory layout of PixelType_BayerGB12Packed and PixelType_BayerGB12p is different.

PixelType_BayerBG12Packed 

Indicates the Bayer BG 12 Packed pixel format. The memory layout of PixelType_BayerBG12Packed and PixelType_BayerBG12p is different.

PixelType_BayerGR10p 

Indicates the BayerGR10p pixel format.

PixelType_BayerRG10p 

Indicates the BayerRG10p pixel format.

PixelType_BayerGB10p 

Indicates the BayerGB10p pixel format.

PixelType_BayerBG10p 

Indicates the BayerBG10p pixel format.

PixelType_BayerGR12p 

Indicates the BayerGR12p pixel format. The memory layout of PixelType_BayerGR12Packed and PixelType_BayerGR12p is different.

PixelType_BayerRG12p 

Indicates the BayerRG12p pixel format. The memory layout of PixelType_BayerRG12Packed and PixelType_BayerRG12p is different.

PixelType_BayerGB12p 

Indicates the BayerGB12p pixel format. The memory layout of PixelType_BayerGB12Packed and PixelType_BayerGB12p is different.

PixelType_BayerBG12p 

Indicates the BayerBG12p pixel format. The memory layout of PixelType_BayerBG12Packed and PixelType_BayerBG12p is different.

PixelType_BayerGR16 

Indicates the Bayer GR 16 pixel format.

PixelType_BayerRG16 

Indicates the Bayer RG 16 pixel format.

PixelType_BayerGB16 

Indicates the Bayer GB 16 pixel format.

PixelType_BayerBG16 

Indicates the Bayer BG 16 pixel format.

PixelType_RGB12V1packed 

Indicates the RGB 12 V1 packed pixel format.

PixelType_Double 

Indicates the Double pixel format.

The reason why a wait operation terminated.

Enumerator
waitex_timeout 

The time-out interval elapsed.

waitex_signaled 

The wait operation completed successfully.

waitex_abandoned 

Windows only (see MSDN for more information)

waitex_alerted 

The wait was interrupted (Windows: queued APC or I/O completion routine; UNIX: signal)

Function Documentation

GENAPIC_RESULT PylonBitsPerPixel ( EPylonPixelType  pixelType,
int *  pResult 
)

Return the number of bits per pixel for a pixel type.

Parameters
[in]pixelTypePixel type
[out]pResultResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Returns the number of bits required to store a single pixel for the given format.

GENAPIC_RESULT PylonChunkParserAttachBuffer ( PYLON_CHUNKPARSER_HANDLE  hChp,
const void *  pBuffer,
size_t  BufLen 
)

Attach a data buffer to a chunk parser.

Parameters
[in]hChpChunk parser handle
[in]pBufferData buffer pointer
[in]BufLenSize of data buffer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Attach a data buffer containing chunk data to a chunk parser.

GENAPIC_RESULT PylonChunkParserCheckCRC ( PYLON_CHUNKPARSER_HANDLE  hChp,
_Bool *  pResult 
)

Return true if CRC checksum chunk data is valid.

Parameters
[in]hChpChunk parser handle
[out]pResultBoolean result pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Check, whether the chunk data buffer contains valid data using its CRC checksum. The boolean result pointed to by pResult is set to true if the checksum matches the data, false otherwise.

GENAPIC_RESULT PylonChunkParserDetachBuffer ( PYLON_CHUNKPARSER_HANDLE  hChp)

Detach a data buffer from a chunk parser.

Parameters
[in]hChpChunk parser handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Detach data buffer from chunk parser.

GENAPIC_RESULT PylonChunkParserHasCRC ( PYLON_CHUNKPARSER_HANDLE  hChp,
_Bool *  pResult 
)

Return true if CRC checksum chunk data is present.

Parameters
[in]hChpChunk parser handle
[out]pResultBoolean result pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Check, whether the chunk data buffer has an attached CRC checksum.

GENAPIC_RESULT PylonChunkParserUpdateBuffer ( PYLON_CHUNKPARSER_HANDLE  hChp,
const void *  pBuffer 
)

Replace a data buffer attached to a chunk parser.

Parameters
[in]hChpChunk parser handle
[in]pBufferData buffer pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Replace a data buffer currently attached to a chunk parser with another one of identical layout.

GENAPIC_RESULT PylonCreateDeviceByIndex ( size_t  index,
PYLON_DEVICE_HANDLE phDev 
)

Create a device object.

Parameters
[in]indexIndex of device info object
[out]phDevPointer to result device handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function creates a device object from a device info object identified by its index index.

GENAPIC_RESULT PylonDestroyDevice ( PYLON_DEVICE_HANDLE  hDev)

Delete a device object.

Parameters
[in]hDevDevice object handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function destroys a device object previously created by PylonCreateDeviceByIndex().

GENAPIC_RESULT PylonDeviceAccessMode ( PYLON_DEVICE_HANDLE  hDev,
int *  pAccessMode 
)

Return access mode flags for a device.

Parameters
[in]hDevDevice handle
[out]pAccessModeResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Given a device handle, this function returns the access mode specified when the device was created.

GENAPIC_RESULT PylonDeviceClose ( PYLON_DEVICE_HANDLE  hDev)

Close a device.

Parameters
[in]hDevDevice handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function closes a device. After closing, the device can no longer be accessed.

GENAPIC_RESULT PylonDeviceCreateChunkParser ( PYLON_DEVICE_HANDLE  hDev,
PYLON_CHUNKPARSER_HANDLE phChp 
)

Create a chunk parser for a device.

Parameters
[in]hDevDevice handle
[out]phChpResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function creates a chunk parser for a device and returns a handle for it. If the device does not support a chunk parser an invalid handle is returned.

GENAPIC_RESULT PylonDeviceCreateEventAdapter ( PYLON_DEVICE_HANDLE  hDev,
PYLON_EVENTADAPTER_HANDLE phEva 
)

Create an event adapter for a device.

Parameters
[in]hDevDevice handle
[out]phEvaResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function creates an event adapter for a device and returns a handle for it. If the device does not support an event adapter an invalid handle is returned.

GENAPIC_RESULT PylonDeviceDeregisterRemovalCallback ( PYLON_DEVICE_HANDLE  hDev,
PYLON_DEVICECALLBACK_HANDLE  hCb 
)

Unregister device removal callback.

Parameters
[in]hDevDevice handle
[in]hCbCallback handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Detach a device removal callback from a device.

GENAPIC_RESULT PylonDeviceDestroyChunkParser ( PYLON_DEVICE_HANDLE  hDev,
PYLON_CHUNKPARSER_HANDLE  hChp 
)

Destroy a chunk parser.

Parameters
[in]hDevDevice handle
[in]hChpChunk parser handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function destroys a chunk parser handle previously obtained from the device by calling PylonDeviceCreateChunkParser().

GENAPIC_RESULT PylonDeviceDestroyEventAdapter ( PYLON_DEVICE_HANDLE  hDev,
PYLON_EVENTADAPTER_HANDLE  hEva 
)

Destroy an event adapter.

Parameters
[in]hDevDevice handle
[in]hEvaEvent adapter handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function destroys an event adapter handle previously obtained from the device by calling PylonDeviceCreateEventAdapter().

GENAPIC_RESULT PylonDeviceExecuteCommandFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName 
)

Execute a command.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a command feature node with a given name and try to execute its command.

GENAPIC_RESULT PylonDeviceFeatureFromString ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
const char *  pValue 
)

Set a feature's value from a string.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[in]pValuePointer to string argument
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and set its value from the argument stringvalue.

GENAPIC_RESULT PylonDeviceFeatureGetAccessMode ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
EGenApiAccessMode pValue 
)

Return a feature's access permissions.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its access modein the variable pointed to by pValue.

_Bool PylonDeviceFeatureIsAvailable ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName 
)

Return boolean 'available' status for feature.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
Returns
True if feature is available, false if not

Look up a feature node with a given name and and return its 'available' status (PylonDeviceFeatureGetAccessMode() returns neither NA nor NI).

_Bool PylonDeviceFeatureIsImplemented ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName 
)

Return boolean 'implemented' status for feature.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
Returns
True if feature is implemented, false if not

Look up a feature node with a given name and and return its 'implemented' status (PylonDeviceFeatureGetAccessMode() returns not NI).

_Bool PylonDeviceFeatureIsReadable ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName 
)

Return boolean 'readable' status for feature.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
Returns
True if feature is readable, false if not

Look up a feature node with a given name and and return its 'readable' status (PylonDeviceFeatureGetAccessMode() returns RO or RW).

_Bool PylonDeviceFeatureIsWritable ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName 
)

Return boolean 'writable' status for feature.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
Returns
True if feature is writable, false if not

Look up a feature node with a given name and and return its 'writable' status (PylonDeviceFeatureGetAccessMode() returns WO or RW).

GENAPIC_RESULT PylonDeviceFeatureToString ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
char *  pBuf,
size_t *  pBufLen 
)

Return a feature's value as a string.

Parameters
[in]hDevDevice handle
[in]pNameFeature pName
[out]pBufPointer to string buffer receiving result
[in,out]pBufLenString buffer size
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and return its value as string. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

GENAPIC_RESULT PylonDeviceGetBooleanFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
_Bool *  pValue 
)

Return a boolean feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its boolean valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetDeviceInfo ( PYLON_DEVICE_HANDLE  hDev,
PylonDeviceInfo_t pDeviceInfo 
)

Get device information from device.

Parameters
[in]hDevDevice handle
[out]pDeviceInfoResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Given a device handle, this function will return basic information about the device in a PylonDeviceInfo_t struct pointed to by pDeviceInfo. Do not confuse a PylonDeviceInfo_t struct with a PYLON_DEVICE_INFO_HANDLE. They are completly unrelated.

GENAPIC_RESULT PylonDeviceGetDeviceInfoHandle ( PYLON_DEVICE_HANDLE  hDev,
PYLON_DEVICE_INFO_HANDLE phDi 
)

Return the handle to the device info object from which a device was created.

Parameters
[in]hDevDevice handle
[out]phDiResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Given a device handle, this function returns a handle for the device object from which the device has originally been created.

GENAPIC_RESULT PylonDeviceGetEventGrabber ( PYLON_DEVICE_HANDLE  hDev,
PYLON_EVENTGRABBER_HANDLE phEvg 
)

Obtain an event grabber handle from a device.

Parameters
[in]hDevDevice handle
[out]phEvgResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for an event grabber of a device.

GENAPIC_RESULT PylonDeviceGetFloatFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
double *  pValue 
)

Return a float feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetFloatFeatureMax ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
double *  pValue 
)

Return a float feature's maximum value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its maximum valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetFloatFeatureMin ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
double *  pValue 
)

Return a float feature's minimum value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its minimum valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetIntegerFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
int64_t *  pValue 
)

Return an integer feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetIntegerFeatureInc ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
int64_t *  pValue 
)

Return an integer feature's increment value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its increment valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetIntegerFeatureMax ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
int64_t *  pValue 
)

Return an integer feature's maximum value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its maximum valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetIntegerFeatureMin ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
int64_t *  pValue 
)

Return an integer feature's minimum value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pValueResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and return its minimum valuein the variable pointed to by pValue.

GENAPIC_RESULT PylonDeviceGetNodeMap ( PYLON_DEVICE_HANDLE  hDev,
NODEMAP_HANDLE phMap 
)

Return the parameter node map for a device.

Parameters
[in]hDevDevice handle
[out]phMapResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for the node map of a device. If the device does not support a node map an invalid handle is returned.

GENAPIC_RESULT PylonDeviceGetNumStreamGrabberChannels ( PYLON_DEVICE_HANDLE  hDev,
size_t *  pNumChannels 
)

Return the number of stream grabber channels for a device.

Parameters
[in]hDevDevice handle
[out]pNumChannelsResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the number of stream grabber channels supported by the device.

Note
Some devices may return 0 as they do not support stream grabbers at all.
GENAPIC_RESULT PylonDeviceGetStreamGrabber ( PYLON_DEVICE_HANDLE  hDev,
size_t  index,
PYLON_STREAMGRABBER_HANDLE phStg 
)

Obtain a stream grabber handle from a device.

Parameters
[in]hDevDevice handle
[in]indexStream grabber index. This value must be in the range of 0 .. (PylonDeviceGetNumStreamGrabberChannels()-1)
[out]phStgResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for one of the stream grabbers supported by the device.

GENAPIC_RESULT PylonDeviceGetTLNodeMap ( PYLON_DEVICE_HANDLE  hDev,
NODEMAP_HANDLE phMap 
)

Obtain a transport layer parameter node map from a device.

Parameters
[in]hDevDevice handle
[out]phMapResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for the transport layer node map of a device. If the device does not support a transport layer node map an invalid handle is returned. You must use the GenApi functions to access nodes in the node map.

GENAPIC_RESULT PylonDeviceGrabSingleFrame ( PYLON_DEVICE_HANDLE  hDev,
size_t  channel,
void *  pBuffer,
size_t  bufferSize,
PylonGrabResult_t pGrabResult,
_Bool *  pReady,
uint32_t  timeout 
)

Set the acquision mode to 'single frame' and grab one image.

Parameters
[in]hDevDevice handle
[in]channelStream grabber channel to use
[out]pBufferBuffer receiving image data
[in]bufferSizeData buffer size
[out]pGrabResultPointer to variable receiving grab result
[out]pReadyPointer to 'buffer ready' flag
[in]timeoutGrab timeout
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Grab a single image into the data buffer passed in pBuffer. Wait at most timeout milliseconds for the camera to produce an image.

GENAPIC_RESULT PylonDeviceInfoGetNumProperties ( PYLON_DEVICE_INFO_HANDLE  hDi,
size_t *  numProperties 
)

Return the number of properties stored in a device info object.

Parameters
[in]hDiDevice info handle
[out]numPropertiesResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the total number of properties of the device info object represented by hDi has.

GENAPIC_RESULT PylonDeviceInfoGetPropertyName ( PYLON_DEVICE_INFO_HANDLE  hDi,
size_t  index,
char *  pBuf,
size_t *  pBufLen 
)

Return the name of a device property identified by its index.

Parameters
[in]hDiDevice info handle
[in]indexProperty index. This value must be in the range 0 .. (PylonDeviceInfoGetNumProperties()-1)
[out]pBufBuffer receiving result
[in,out]pBufLenPointer to buffer length
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the name of the device property identified by index index. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByIndex ( PYLON_DEVICE_INFO_HANDLE  hDi,
size_t  index,
char *  pBuf,
size_t *  pBufLen 
)

Return the value of a device property identified by its index.

Parameters
[in]hDiDevice info handle
[in]indexProperty index. This value must be in the range 0 .. (PylonDeviceInfoGetNumProperties()-1)
[out]pBufBuffer receiving result
[in,out]pBufLenPointer to buffer length
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the value of the device property identified by index index. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

GENAPIC_RESULT PylonDeviceInfoGetPropertyValueByName ( PYLON_DEVICE_INFO_HANDLE  hDi,
const char *  pName,
char *  pBuf,
size_t *  pBufLen 
)

Return the value of a device property identified by its name.

Parameters
[in]hDiDevice info handle
[in]pNameProperty name
[out]pBufBuffer receiving result
[in,out]pBufLenPointer to buffer length
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the value of the device property identified by its name. The buffer passed to this function must be large enough to hold the entire string, including a terminating zero. If the function is called with pBuf set to NULL, the variable pointed to by pBufLen is set to the required buffer size.

GENAPIC_RESULT PylonDeviceIsCommandDone ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
_Bool *  pResult 
)

Return true if command execution has finished.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[out]pResultPointer to boolean result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Look up a command feature node with a given name and return true if the node is not currently busy executing its command, false otherwise.

GENAPIC_RESULT PylonDeviceIsOpen ( PYLON_DEVICE_HANDLE  hDev,
_Bool *  pOpen 
)

Return device open status.

Parameters
[in]hDevDevice handle
[out]pOpenResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Call this function to find out whether a device is currently open.

GENAPIC_RESULT PylonDeviceOpen ( PYLON_DEVICE_HANDLE  hDev,
int  accessMode 
)

Open a device.

Parameters
[in]hDevDevice handle
[in]accessModeIntended access mode. You can pass one or more of the flags specified below.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function opens a device. A device must be opened before any operations can be performed on it. The accessMode argument can be used to restrict the type of access allowed by the device. The following access modes are available:

  • PYLONC_ACCESS_MODE_CONTROL - Allows to read or write camera parameters to configure the camera.
  • PYLONC_ACCESS_MODE_STREAM - Allows to read image data from the camera's stream grabber object.
  • PYLONC_ACCESS_MODE_EVENT - Allows to read event data from the camera's stream grabber object.
  • PYLONC_ACCESS_MODE_EXCLUSIVE - Allows exclusive access. When this flag is specified no other application may access the camera.
  • PYLONC_ACCESS_MODE_MONITOR - Allows only read access. This flag cannot be combined with any other flags. It is typically used in Multicast/Broadcast applications with GigE cameras.

You can pass one or more flags. If you pass more than one flag you can combine them using the 'or' operator.

GENAPIC_RESULT PylonDevicePortRead ( PYLON_DEVICE_HANDLE  hDev,
void *  pBuffer,
int64_t  Address,
size_t  Length 
)

Perform a raw read on the standard "Device"-node port.

Parameters
[in]hDevNode of the port to read from. Use GenApiNodeMapGetNode to get the nodehandle.
[in]pBufferPoints to the buffer to copy the data to.
[in]AddressAddress to start reading data from.
[in]LengthNumber of bytes to read starting at Address.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Reads raw data from the "Device" port. Specify the address from where to read data. The count of data bytes passed in Length is read. The data read will be written to the buffer passed in pBuffer. Make sure the buffer has at least a size of Length-bytes.

GENAPIC_RESULT PylonDevicePortWrite ( PYLON_DEVICE_HANDLE  hDev,
const void *  pBuffer,
int64_t  Address,
size_t  Length 
)

Perform a raw write on the standard "Device"-node port.

Parameters
[in]hDevNode of the port to write to. Use GenApiNodeMapGetNode to get the nodehandle.
[in]pBufferPoints to the buffer to read the data from.
[in]AddressAddress to start writing the data to.
[in]LengthNumber of bytes to write starting at Address.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Writes raw data to the "Device" port. Specify the address from where to read data. The count of data bytes passed in Length is read. The data read will be read from the buffer passed in pBuffer.

GENAPIC_RESULT PylonDeviceRegisterRemovalCallback ( PYLON_DEVICE_HANDLE  hDev,
PylonDeviceRemCb_t pCbFunction,
PYLON_DEVICECALLBACK_HANDLE phCb 
)

Register device removal callback.

Parameters
[in]hDevDevice handle
[in]pCbFunctionCallback function pointer
[out]phCbPointer to callback handle result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Register a device removal callback on the device. The callback function will be called when the device is removed (unplugged). When the callback is fired all subsequent calls to functions which need to communicate with the device will fail.

Some devices may not support callback removal and will return an invalid handle.

Note
The time the callback will be fired can vary depending on the transport layer used. Some devices, e.g. devices with GigE interface, may take some time to detect the device removal (see Debugging pylon Applications When Using GigE Cameras). If your program is currently grabbing images it is likely to get failed buffers before the callback is fired.
GENAPIC_RESULT PylonDeviceSetBooleanFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
_Bool  value 
)

Set a boolean feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[in]valueValue to set
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and set its boolean value from argument value.

GENAPIC_RESULT PylonDeviceSetFloatFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
double  value 
)

Set a float feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[in]valueValue to set. Make sure the value is in the range of PylonDeviceGetFloatFeatureMin() .. PylonDeviceGetFloatFeatureMax()
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and set its value from argument value.

GENAPIC_RESULT PylonDeviceSetIntegerFeature ( PYLON_DEVICE_HANDLE  hDev,
const char *  pName,
int64_t  value 
)

Set an integer feature's value.

Parameters
[in]hDevDevice handle
[in]pNamePointer to feature name
[in]valueValue to set. Make sure the value is valid for the node (see remarks)
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Look up a feature node with a given name and and set its value from argument value. The value must obey certain rules which may vary from node to node. The value must be in the range PylonDeviceGetIntegerFeatureMin()..PylonDeviceGetIntegerFeatureMax(). The value must also be PylonDeviceGetIntegerFeatureMin() + N * PylonDeviceGetIntegerFeatureInc() with N = 0,1,2,3,...,n

GENAPIC_RESULT PylonEnumerateDevices ( size_t *  numDevices)

Enumerate all camera devices.

Parameters
[out]numDevicesResult value pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. Depending on device class, other errors are possible as well.

This function returns the total count of all camera devices detected by the pylon C system regardless of the cameras' interfaces (GigE, IEEE 1394, Camera Link,...).

GENAPIC_RESULT PylonEventAdapterDeliverMessage ( PYLON_EVENTADAPTER_HANDLE  hEva,
const PylonEventResult_t pEventResult 
)

Process event messages.

Parameters
[in]hEvaEvent adapter handle
[in]pEventResultEvent buffer to process
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Pass an event buffer to an event adapter. The events in the buffer will be processed, updating properties of the device associated with the event adapter.

GENAPIC_RESULT PylonEventGrabberClose ( PYLON_EVENTGRABBER_HANDLE  hEvg)

Close an event grabber.

Parameters
[in]hEvgEvent grabber to close
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Close an event grabber after use.

GENAPIC_RESULT PylonEventGrabberGetNodeMap ( PYLON_EVENTGRABBER_HANDLE  hEvg,
NODEMAP_HANDLE phMap 
)

Return an event grabber's parameter node map.

Parameters
[in]hEvgEvent grabber handle
[out]phMapPointer to node map handle result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Return a handle for the event grabber's parameter node map. If the event grabber does not support a node map an invalid handle is returned.

GENAPIC_RESULT PylonEventGrabberGetNumBuffers ( PYLON_EVENTGRABBER_HANDLE  hEvg,
size_t *  pNumBuffers 
)

Return the number of event buffers used by an event grabber.

Parameters
[in]hEvgEvent grabber handle
[out]pNumBuffersResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Returns the number of event buffers for an event grabber.

GENAPIC_RESULT PylonEventGrabberGetWaitObject ( PYLON_EVENTGRABBER_HANDLE  hEvg,
PYLON_WAITOBJECT_HANDLE phWobj 
)

Return an event grabber's wait object.

Parameters
[in]hEvgEvent grabber handle
[out]phWobjResult wait object pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a wait object handle for an event grabber.

GENAPIC_RESULT PylonEventGrabberIsOpen ( PYLON_EVENTGRABBER_HANDLE  hEvg,
_Bool *  pOpen 
)

Return an event grabber's boolean 'open' status.

Parameters
[in]hEvgEvent grabber to check
[out]pOpenBoolean result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Check, whether an event grabber is currently open.

GENAPIC_RESULT PylonEventGrabberOpen ( PYLON_EVENTGRABBER_HANDLE  hEvg)

Open an event grabber.

Parameters
[in]hEvgEvent grabber to open
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Open an event grabber for use.

GENAPIC_RESULT PylonEventGrabberRetrieveEvent ( PYLON_EVENTGRABBER_HANDLE  hEvg,
PylonEventResult_t pEventResult,
_Bool *  pReady 
)

Retrieve an event from an event grabber.

Parameters
[in]hEvgEvent grabber handle
[out]pEventResultPointer to result data struct
[out]pReadyPointer to 'ready' flag
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Calling this function returns a boolean status in the variable pointed to by pReady , indicating whether at least one event is available. If so, the event is returned in the result struct pointed to by pEventResult.

GENAPIC_RESULT PylonEventGrabberSetNumBuffers ( PYLON_EVENTGRABBER_HANDLE  hEvg,
size_t  numBuffers 
)

Set the number of event buffers used by an event grabber.

Parameters
[in]hEvgEvent grabber handle
[in]numBuffersNew buffer count
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Set the number of event buffers for an event grabber.

GENAPIC_RESULT PylonFeaturePersistenceLoad ( NODEMAP_HANDLE  hMap,
const char *  pFileName,
_Bool  verify 
)

Loads the features from a file and stores it to the node tree.

Parameters
[in]hMapNode map handle.
[in]pFileNameName of the file containing the node map values.
[in]verifyIf verify==true (default) all node values will be validated.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Loads the features from a file and stores it to the node tree.

GENAPIC_RESULT PylonFeaturePersistenceLoadFromString ( NODEMAP_HANDLE  hMap,
const char *  pFeatures,
_Bool  verify 
)

Loads the features from a string and stores it to the node tree.

Parameters
[in]hMapNode map handle.
[in]pFeaturesThe string containing the node map values.
[in]verifyIf verify==true (default) all node values will be validated.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Loads the features from a string and stores it to the node tree.

GENAPIC_RESULT PylonFeaturePersistenceSave ( NODEMAP_HANDLE  hMap,
const char *  pFileName 
)

Saves the node tree to a file.

Parameters
[in]pFileNameName of the file to store the node map values in.
[in]hMapNode map handle.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Sequence sets of a camera are automatically saved when SequenceEnable is activated.

GENAPIC_RESULT PylonFeaturePersistenceSaveToString ( NODEMAP_HANDLE  hMap,
char *  pFeatures,
size_t *  pFeaturesLen 
)

Saves the node tree to a string.

Parameters
[in]hMapNode map handle.
[in]pFeaturesThe string to store the node map values in.
[in]pFeaturesLenThe size string buffer to store the node map values in.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Sequence sets of a camera are automatically saved if SequenceEnable is activated.

GENAPIC_RESULT PylonGetDeviceInfo ( size_t  index,
PylonDeviceInfo_t pDi 
)

Get information about camera device identified by its index.

Parameters
[in]indexDevice index.
[out]pDiPointer to camera device info struct to fill
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Given a device index, this function returns information about the camera device in a PylonDeviceInfo_t struct pointed to by pDi. The index parameter must be lower than the numDevices parameter returned from PylonEnumerateDevices().

Note
Do not confuse a PylonDeviceInfo_t struct with a PYLON_DEVICE_INFO_HANDLE. They are completly unrelated.
GENAPIC_RESULT PylonGetDeviceInfoHandle ( size_t  index,
PYLON_DEVICE_INFO_HANDLE phDi 
)

Return a handle for a camera device info object.

Parameters
[in]indexDevice index
[out]phDiDevice info handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for a device info object for the device identified by index index. The index parameter must be lower than the numDevices parameter returned from PylonEnumerateDevices().

GENAPIC_RESULT PylonGigEAnnounceRemoteDevice ( const char *  pIpAddress)

Announce that a remote device is going to be used.

Note
This device must be reachable, a route is configured.
Parameters
[in]pIpAddressAddress of device in "dot notation"
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Announce that a remote device is going to be used.

GENAPIC_RESULT PylonGigEBroadcastIpConfiguration ( const char *  pMacAddress,
_Bool  EnablePersistentIp,
_Bool  EnableDHCP,
const char *  pIpAddress,
const char *  pSubnetMask,
const char *  pDefaultGateway,
const char *  pUserdefinedName,
_Bool *  pRetval 
)

Broadcasts the IP configuration.

Parameters
[in]pMacAddressspecifies the target device
[in]EnablePersistentIpenable persistent (static) IP configuration
[in]EnableDHCPenable DHCP configuration
[in]pIpAddressIP address, "dot notation", e.g., 192.168.1.2
[in]pSubnetMaskSubnetMask, "dot notation", eg. 255.255.255.0
[in]pDefaultGatewayDefaultGateway, "dot notation", e.g., 192.168.1.1
[in]pUserdefinedNamestring with name for the device
[out]pRetvalwhether the configuration was applied successfully
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Broadcasts the IP configuration for the device with the specified MAC address.

GENAPIC_RESULT PylonGigEChangeIpConfiguration ( PYLON_DEVICE_HANDLE  hDev,
_Bool  EnablePersistentIp,
_Bool  EnableDhcp 
)

Enables/disables use of a persistent IP address and DHCP usage.

Parameters
[in]hDevDevice handle
[in]EnablePersistentIpEnable use of persistent IP address
[in]EnableDhcpEnable use of DHCP
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Enables/disables use of a persistent IP address and DHCP usage.

GENAPIC_RESULT PylonGigEEnumerateAllDevices ( size_t *  numDevices)

Enumerate all GigE camera devices in all subnets.

Parameters
[out]numDevicesResult value pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. Depending on device class, other errors are possible as well

This function returns the total count of all GigE camera devices detected by the pylon C system. In contrast to the PylonEnumerateDevices() method, devices will be listed that have a subnet configured that is different from the subnet of the application.

GENAPIC_RESULT PylonGigEForceIp ( const char *  pMacAddress,
const char *  pIpAddress,
const char *  pSubnetMask,
const char *  pDefaultGateway 
)

'Force' a static IP address configuration into a device identified by its MAC Address.

Parameters
[in]pMacAddressMAC address as a string, no delimiters are used. e.g., 003053061a58
[in]pIpAddressTemporary IP address, "dot notation", e.g., 192.168.1.2
[in]pSubnetMaskTemporary SubnetMask, "dot notation", eg. 255.255.255.0
[in]pDefaultGatewayTemporary DefaultGateway, "dot notation", e.g., 192.168.1.1
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

When calling this function, there must be no opened camera object for the device to reconfigure! PylonDeviceInfoGetPropertyValueByName() can be used to retrieve the MAC Address using the 'MacAddress' key.

GENAPIC_RESULT PylonGigEGetPersistentIpAddress ( PYLON_DEVICE_HANDLE  hDev,
char *  pIpAddress,
size_t *  pIpAddressLen,
char *  pSubnetMask,
size_t *  pSubnetMaskLen,
char *  pDefaultGateway,
size_t *  pDefaultGatewayLen 
)

Reads the persistent IP address from the device.

Parameters
[in]hDevDevice handle
[out]pIpAddressIP address, "dot notation", e.g., 192.168.1.2
[in,out]pIpAddressLenPointer to buffer length
[out]pSubnetMaskSubnetMask, "dot notation", eg. 255.255.255.0
[in,out]pSubnetMaskLenPointer to buffer length
[out]pDefaultGatewayDefaultGateway, "dot notation", e.g., 192.168.1.1
[in,out]pDefaultGatewayLenPointer to buffer length
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Reads the persistent IP address from the device.

GENAPIC_RESULT PylonGigEIssueActionCommand ( uint32_t  deviceKey,
uint32_t  groupKey,
uint32_t  groupMask,
const char *  pBroadcastAddress,
uint32_t  timeoutMs,
uint32_t *  pNumResults,
PylonGigEActionCommandResult_t pResults 
)

Issue an action command via broadcast.

Parameters
[in]deviceKeyThe device key addresses devices managed by an application. The device key is only known to the application controlling its camera devices and it ensures that only this application can trigger the camera devices. Therefore the device key cannot be read from a device. An exact match of the send deviceKey and the device key stored in a device is required for executing an action.
[in]groupKeyThe group key is used to create groups of devices or actions. An exact match of the send groupKey and the group key stored in a device for an action is required for executing an action.
[in]groupMaskThe groupMask is a bit mask that allows to send an action to a subgroup of the devices addressed by the deviceKey groupKey pair. The result of a bitwise AND operation of groupMask and the group mask stored in a device for an action must be non-zero for executing an action.
[in]pBroadcastAddressBroadcastAddress in dot notation where the command will be broadcast to, e.g. 255.255.255.255 (all adapters, default), 192.168.1.255 (all devices in a single subnet 192.168.1.xxx), 192.168.1.38 (single device). See the note below.
[in]timeoutMsOptional: Time in milliseconds the call is waiting for acknowledges of the addressed devices. Waiting for acknowledges is stopped if pNumResults have been received. This parameter can be 0 if a check of action command results is not required.
[in,out]pNumResultsOptional: The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
[out]pResultsOptional: An array with *pNumResults elements to hold the action command result status. The buffer is filled beginning from the start. Remaining results are not changed if less results are received than result items available. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

The action command feature lets you trigger actions in multiple devices (e.g. cameras) at roughly the same time or at a defined point in time (scheduled action command) by using a single broadcast protocol message (without extra cabling). Action commands are used in cameras in the same way as for example the digital input lines.

Note
If a Microsoft Windows operating system is used, sending a broadcast out on multiple network interfaces is executed for each interface sequentially. That's why additional latency is added to the execution time of a command, when sending a broadcast message over a wider broadcast address range than required, e.g. when using the broadcast address 255.255.255.255.
Precondition
  • IP4 addresses must be used.
  • groupMask must not be 0.
  • pNumResult, *pNumResult and pResults must not be 0 if a timeoutMs value other than 0 is passed.
Thread Safety:
The method is thread-safe.
GENAPIC_RESULT PylonGigEIssueScheduledActionCommand ( uint32_t  deviceKey,
uint32_t  groupKey,
uint32_t  groupMask,
uint64_t  actionTimeNs,
const char *  pBroadcastAddress,
uint32_t  timeoutMs,
uint32_t *  pNumResults,
PylonGigEActionCommandResult_t pResults 
)

Issue a scheduled action command via broadcast.

Parameters
[in]deviceKeyThe device key addresses devices managed by an application. The device key is only known to the application controlling its camera devices and it ensures that only this application can trigger the camera devices. Therefore the device key cannot be read from a device. An exact match of the send deviceKey and the device key stored in a device is required for executing an action.
[in]groupKeyThe group key is used to create groups of devices or actions. An exact match of the send groupKey and the group key stored in a device for an action is required for executing an action.
[in]groupMaskThe groupMask is a bit mask that allows to send an action to a subgroup of the devices addressed by the deviceKey groupKey pair. The result of a bitwise AND operation of groupMask and the group mask stored in a device for an action must be non-zero for executing an action.
[in]actionTimeNsTime in nanoseconds when the action is to be executed. The actual value depends on the used master clock. A master clock value can be obtained for instance for a set of synchronized camera devices by reading the timestamp value (GevTimestampValue) after latching the timestamp value (GevTimestampControlLatch) from one camera device of the set.
[in]pBroadcastAddressBroadcastAddress in dot notation where the command will be broadcast to, e.g. 255.255.255.255 (all adapters, default), 192.168.1.255 (all devices in a single subnet 192.168.1.xxx), 192.168.1.38 (single device). See the note below.
[in]timeoutMsOptional: Time in milliseconds the call is waiting for acknowledges of the addressed devices. Waiting for acknowledges is stopped if pNumResults have been received. This parameter can be 0 if a check of action command results is not required.
[in,out]pNumResultsOptional: The number of results in the results array. The value passed should be equal to the expected number of devices that acknowledge the command. Returns the number of received results. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
[out]pResultsOptional: An array with *pNumResults elements to hold the action command result status. The buffer is filled beginning from the start. Remaining results are not changed if less results are received than result items available. This parameter is ignored if timeoutMs is 0. Thus, this parameter can be NULL if timeoutMs is 0.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

The action command feature lets you trigger actions in multiple devices (e.g. cameras) at roughly the same time or at a defined point in time (scheduled action command) by using a single broadcast protocol message (without extra cabling). Action commands are used in cameras in the same way as for example the digital input lines.

Note
If a Microsoft Windows operating system is used, sending a broadcast out on multiple network interfaces is executed for each interface sequentially. That's why additional latency is added to the execution time of a command, when sending a broadcast message over a wider broadcast address range than required, e.g. when using the broadcast address 255.255.255.255.
Precondition
  • IP4 addresses must be used.
  • groupMask must not be 0.
  • pNumResult, *pNumResult and pResults must not be 0 if a timeoutMs value other than 0 is passed.
  • actionTimeNs must be smaller than or equal INT64_MAX.
Thread Safety:
The method is thread-safe.
GENAPIC_RESULT PylonGigERenounceRemoteDevice ( const char *  pIpAddress,
_Bool *  pFound 
)

Stop using remote device.

Parameters
[in]pIpAddressAddress of device in "dot notation"
[out]pFoundIf not NULL: information wether device was found or not found. If NULL, this information is ignored.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Stop using remote device.

GENAPIC_RESULT PylonGigERestartIpConfiguration ( const char *  pMacAddress)

Let a device restart the IP configuration cycle.

Parameters
[in]pMacAddressMAC address as a string, no delimiters are used. e.g., 003053061a58
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

This function fails when the device is open, i.e., when a control channel is established. PylonDeviceInfoGetPropertyValueByName() can be used to retrieve the MAC Address using the 'MacAddress' key.

GENAPIC_RESULT PylonGigESetPersistentIpAddress ( PYLON_DEVICE_HANDLE  hDev,
const char *  pIpAddress,
const char *  pSubnetMask,
const char *  pDefaultGateway 
)

Writes a persistent IP address to the device.

Parameters
[in]hDevDevice handle
[in]pIpAddressIP address, "dot notation", e.g., 192.168.1.2
[in]pSubnetMaskSubnetMask, "dot notation", eg. 255.255.255.0
[in]pDefaultGatewayDefaultGateway, "dot notation", e.g., 192.168.1.1
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

Writing the persistent IP address does not change the IP configuration. Use the ChangeIpConfiguration() method to enable the usage of persistent IP addresses.

GENAPIC_RESULT PylonImageFormatConverterConvert ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
void *  targetBuffer,
size_t  targetBufferSize,
const void *  sourceBuffer,
size_t  sourceBufferSize,
EPylonPixelType  sourcePixelType,
uint32_t  sourceWidth,
uint32_t  sourceHeight,
size_t  sourcePaddingX,
EPylonImageOrientation  sourceOrientation 
)

Converts an image.

Parameters
[in]hConvHandle for image format converter.
[in]targetBufferBuffer for converted image data.
[in]targetBufferSizeSize of image buffer for converted data.
[in]sourceBufferBuffer of source image data.
[in]sourceBufferSizeSize of buffer of source image data.
[in]sourcePixelTypePixel type of source image.
[in]sourceWidthNumber of columns (in pixels) of source image.
[in]sourceHeightNumber of rows (in pixels) of source image.
[in]sourcePaddingXThe number of additional data bytes at the end of each image row.
[in]sourceOrientationThe vertical orientation of the source image in the image buffer. The default value is usually ImageOrientation_TopDown.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Converts an image. The buffer size of the target image can be determined by PylonImageFormatConverterGetBufferSizeForConversion.

GENAPIC_RESULT PylonImageFormatConverterCreate ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE phConv)

Creates an image format converter.

Parameters
[in]phConvHandle for the image format converter.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Creates an image format converter and provides a handle for it.

GENAPIC_RESULT PylonImageFormatConverterDestroy ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv)

Destroys an image format converter.

Parameters
[in]hConvHandle of format converter.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Destroys an image format converter.

GENAPIC_RESULT PylonImageFormatConverterGetBufferSizeForConversion ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
EPylonPixelType  sourcePixelType,
uint32_t  sourceWidth,
uint32_t  sourceHeight,
size_t *  pBufSize 
)

Gets the buffer size for a converted image.

Parameters
[in]hConvHandle for image format converter.
[in]sourcePixelTypePixel type of source image.
[in]sourceWidthNumber of columns (in pixels) of source image.
[in]sourceHeightNumber of rows in (pixels) of source image.
[out]pBufSizeBuffer size which is necessary for converted source image.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Gets the buffer size for a converted image. The buffer size depends on the pixel type, the width and the height of the source image and the output padding.

GENAPIC_RESULT PylonImageFormatConverterGetNodeMap ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
NODEMAP_HANDLE phMap 
)

Gets the handle for node map of an image format converter.

Parameters
[in]hConvHandle for the image format converter.
[out]phMapHandle for the node map of the image format converter.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Gets the handle for node map of an image format converter.

GENAPIC_RESULT PylonImageFormatConverterGetOutputPaddingX ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
size_t *  pPaddingX 
)

Gets the padding, i. e. the number of additional data bytes at the end of each image row.

Parameters
[in]hConvThe handle to the image format converter.
[out]pPaddingXThe number of additional data bytes at the end of each image row.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Gets the padding, i. e. the number of additional data bytes at the end of each image row.

GENAPIC_RESULT PylonImageFormatConverterGetOutputPixelFormat ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
EPylonPixelType pPixelType 
)

Gets the output pixel format of an image format converter.

Parameters
[in]hConvHandle for the image format converter.
[out]pPixelTypeThe pixel type which defines the image format.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Gets the output pixel format of an image format converter.

GENAPIC_RESULT PylonImageFormatConverterSetOutputPaddingX ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
size_t  paddingX 
)

Sets the padding, i. e. the number of additional data bytes at the end of each image row.

Parameters
[in]hConvThe handle to the image format converter.
[in]paddingXThe number of additional data bytes at the end of each image row.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Sets the padding, i. e. the number of additional data bytes at the end of each image row.

GENAPIC_RESULT PylonImageFormatConverterSetOutputPixelFormat ( PYLON_IMAGE_FORMAT_CONVERTER_HANDLE  hConv,
EPylonPixelType  pixelType 
)

Sets the output pixel format of an image format converter.

Parameters
[in]hConvHandle for the image format converter.
[in]pixelTypeThe pixel type which defines the image format.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Sets the output pixel format of an image format converter.

GENAPIC_RESULT PylonImagePersistenceLoad ( const char *  pFilename,
void *  pBuffer,
size_t *  pBufferSize,
EPylonPixelType pPixelType,
uint32_t *  pWidth,
uint32_t *  pHeight,
size_t *  pPaddingX,
EPylonImageOrientation pOrientation 
)

Loads an image from disk.

Parameters
[in]pFilenameName and path of the image.
[in]pBufferBuffer to be used.
[out]pBufferSizeIf the buffer size is too small, the buffer size is set to the required buffer size and GENAPI_E_INSUFFICIENT_BUFFER is returned.
[out]pPixelTypePixel type of the loaded image or PixelType_Undefined if the image is invalid.
[out]pWidthThe current number of columns (in pixels) of the loaded image or 0 if the image is invalid.
[out]pHeightThe current number of rows (in pixels) of the loaded image or 0 if the image is invalid.
[out]pPaddingXThe number of extra data bytes at the end of each row or 0 if the image is invalid.
[out]pOrientationThe orientation of the image or ImageOrientation_TopDown if the image is invalid.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Load an image from a file.

GENAPIC_RESULT PylonImagePersistenceSave ( EPylonImageFileFormat  imageFileFormat,
const char *  pFilename,
const void *  pBuffer,
size_t  bufferSize,
EPylonPixelType  pixelType,
uint32_t  width,
uint32_t  height,
size_t  paddingX,
EPylonImageOrientation  orientation,
PylonImagePersistenceOptions_t pOptions 
)

Saves the image to disk. Converts the image to a format that can be saved if required.

If required, the image is automatically converted to a new image and then saved. See CanSaveWithoutConversion() for more information. An image with a bit depth higher than 8 bit is stored with 16 bit bit depth if supported by the image file format. In this case the pixel data is MSB aligned.

If more control over the conversion is required then the CImageFormatConverter class can be used to convert the input image before saving it.

Parameters
[in]imageFileFormatThe file format to save the image in.
[in]pFilenameName and path of the image.
[in]pBufferBuffer which contains the image data.
[in]bufferSizeThe size of the buffer in byte.
[in]pixelTypeThe pixel type of the image to save.
[in]widthThe number of pixels in a row of the image to save.
[in]heightThe number of rows of the image to save.
[in]paddingXThe number of extra data bytes at the end of each row.
[in]orientationThe vertical orientation of the image in the image buffer.
[in]pOptionsThe image persistence save options. This parameter can be NULL.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.
GENAPIC_RESULT PylonInitialize ( void  )

Initialize the pylon C runtime system.

Returns
GENAPI_E_OK This function is guaranteed not to fail.

This function must be called at least once before any other pylon C functions are called. Its purpose is to set up internal structures used by the pylon C system.

GENAPIC_RESULT PylonIsBayer ( EPylonPixelType  pixelType,
_Bool *  pResult 
)

Return true if the pixel format is a Bayer format.

Parameters
[in]pixelTypePixel type
[out]pResultBoolean result pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Returns a boolean result: True - the pixel format is a Bayer format, false otherwise.

GENAPIC_RESULT PylonIsDeviceAccessible ( size_t  index,
int  accessMode,
_Bool *  pIsAccessible 
)

This method can be used to check if a camera device can be created and opened.

Parameters
[in]indexDevice index.
[in]accessModeUsed for defining how a device is accessed. The use of the mode information is transport layer specific. For IIDC 1394 devices the mode information is ignored. For GigE devices the flags Exclusive and Control are used for defining how a device is accessed.
[out]pIsAccessibleTrue if device can be opened with provided access mode.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This method can be used to check if a camera device can be created and opened.

GENAPIC_RESULT PylonIsMono ( EPylonPixelType  pixelType,
_Bool *  pResult 
)

Return true if pixel format is monochrome.

Parameters
[in]pixelTypePixel type
[out]pResultBoolean result pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Returns a boolean result: True - pixel format is monochrome, false otherwise.

GENAPIC_RESULT PylonPixelFormatConverterConvert ( PYLON_FORMAT_CONVERTER_HANDLE  hConv,
void *  targetBuffer,
size_t  targetBufferSize,
const void *  sourceBuffer,
size_t  sourceBufferSize 
)

Deprecated: Convert pixel data to a different format.

Parameters
[in]hConvPixel format converter handle
[out]targetBufferDestination data buffer pointer
[in]targetBufferSizeSize of destination data buffer
[in]sourceBufferSource data buffer pointer
[in]sourceBufferSizeSize of source data buffer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Convert pixel data from source buffer, writing result to destination buffer.

GENAPIC_RESULT PylonPixelFormatConverterCreate ( PYLON_DEVICE_HANDLE  hDev,
int  outAlign,
PYLON_FORMAT_CONVERTER_HANDLE phConv 
)

Deprecated: Create a pixel format converter.

Parameters
[in]hDevDevice handle
[in]outAlignOutput buffer line alignment
[out]phConvPointer to pixel format converter result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Create a pixel format converter. The selection of the output format is based on the camera's native pixel format. All color formats are converted to RGBA (8888) with the 'A' component set to zero. All monochrome formats are converted to Mono8. The outAlign parameter can be used to enforce a particular address alignment of every line in the output buffer. The start address of every output buffer line will be an integer multiple of the outAlign argument.

GENAPIC_RESULT PylonPixelFormatConverterDestroy ( PYLON_FORMAT_CONVERTER_HANDLE  hConv)

Deprecated: Delete a pixel format converter.

Parameters
[in]hConvPixel format converter handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Destroy a previously created pixel format converter.

GENAPIC_RESULT PylonPixelFormatConverterGetOutputBufferSize ( PYLON_FORMAT_CONVERTER_HANDLE  hConv,
size_t *  pBufSiz 
)

Deprecated: Compute required output buffer size for pixel format converter.

Parameters
[in]hConvFormat converter handle
[out]pBufSizResult pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Return the required result buffer size (in bytes) for a color converter.

GENAPIC_RESULT PylonPixelTypeFromString ( const char *  pString,
EPylonPixelType pPixelType 
)

Translate a pixel type name to an enumeration value.

Parameters
[in]pStringString to be converted
[out]pPixelTypePointer to pixel format code result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Converts a text string to a pixel format code that is returned in the variable pointed to by pPixelType. If the string cannot be converted, the result is set to PixelType_Undefined.

GENAPIC_RESULT PylonStreamGrabberCancelGrab ( PYLON_STREAMGRABBER_HANDLE  hStg)

Cancel grab operation.

Parameters
[in]hStgStream grabber handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Tell the stream grabber to stop grabbing immediately. Buffers already queued but not yet processed will be returned with a 'cancelled' status.

GENAPIC_RESULT PylonStreamGrabberClose ( PYLON_STREAMGRABBER_HANDLE  hStg)

Close a stream grabber.

Parameters
[in]hStgStream grabber handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function closes a stream grabber after use.

GENAPIC_RESULT PylonStreamGrabberDeregisterBuffer ( PYLON_STREAMGRABBER_HANDLE  hStg,
PYLON_STREAMBUFFER_HANDLE  hBuf 
)

Detach an image data buffer from a stream grabber.

Parameters
[in]hStgStream grabber handle
[in]hBufBuffer handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Tell the stream grabber that the data buffer represented by hBuf will no longer be used for grabbing.

GENAPIC_RESULT PylonStreamGrabberFinishGrab ( PYLON_STREAMGRABBER_HANDLE  hStg)

Shut down a stream grabber.

Parameters
[in]hStgStream grabber handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Tell the stream grabber that grabbing has finished and that it should release all resources allocated by PylonStreamGrabberPrepareGrab(). After this, the stream grabber setup may be modified again.

GENAPIC_RESULT PylonStreamGrabberGetMaxBufferSize ( PYLON_STREAMGRABBER_HANDLE  hStg,
size_t *  pMaxSize 
)

Return the maximum data buffer size for a stream grabber.

Parameters
[in]hStgStream grabber handle
[out]pMaxSizeResult buffer size pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the maximum data buffer size that a stream grabber is currently set to.

GENAPIC_RESULT PylonStreamGrabberGetMaxNumBuffer ( PYLON_STREAMGRABBER_HANDLE  hStg,
size_t *  pNumBuffers 
)

Return the maximum number of data buffers a stream grabber is set to use.

Parameters
[in]hStgStream grabber handle
[in]pNumBuffersBuffer count to set
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns the number of data buffers the stream grabber is currently prepared to accept.

GENAPIC_RESULT PylonStreamGrabberGetNodeMap ( PYLON_STREAMGRABBER_HANDLE  hStg,
NODEMAP_HANDLE phMap 
)

Return the node map for a stream grabber.

Parameters
[in]hStgStream grabber handle
[out]phMapPointer to node map handle result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Return the handle for the stream grabber's node map. If the stream grabber does not support a node map an invalid handle is returned.

GENAPIC_RESULT PylonStreamGrabberGetWaitObject ( PYLON_STREAMGRABBER_HANDLE  hStg,
PYLON_WAITOBJECT_HANDLE phWobj 
)

Return a stream grabber's wait object.

Parameters
[in]hStgStream grabber handle
[out]phWobjResult wait object pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a wait object handle of the stream grabber. You can use this handle to wait for a buffer using PylonWaitObjectWait() or pass it to wait object set using PylonWaitObjectsAdd().

GENAPIC_RESULT PylonStreamGrabberIsOpen ( PYLON_STREAMGRABBER_HANDLE  hStg,
_Bool *  pOpen 
)

Return the boolean 'open' status of a stream grabber.

Parameters
[in]hStgStream grabber handle
[out]pOpenResult Pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function checks whether a stream grabber is currently open.

GENAPIC_RESULT PylonStreamGrabberOpen ( PYLON_STREAMGRABBER_HANDLE  hStg)

Open a stream grabber.

Parameters
[in]hStgStream grabber handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function opens a stream grabber for use.

GENAPIC_RESULT PylonStreamGrabberPrepareGrab ( PYLON_STREAMGRABBER_HANDLE  hStg)

Prepare a stream grabber for grabbing.

Parameters
[in]hStgStream grabber handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Tell the stream grabber that no more setup operations (data buffer registration etc.) will be done, and that it should get ready for grabbing by allocating all required resources. After calling this function, further setup operations will be rejected.

GENAPIC_RESULT PylonStreamGrabberQueueBuffer ( PYLON_STREAMGRABBER_HANDLE  hStg,
PYLON_STREAMBUFFER_HANDLE  hBuf,
const void *  pContext 
)

Submit a data buffer to a stream grabber.

Parameters
[in]hStgStream grabber handle
[in]hBufData buffer handle
[in]pContextApplication context pointer
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Append the data buffer represented by hBuf to the stream grabber's queue. Continuously processing the queue, the stream grabber will fill the buffer with data as soon as all proceeding buffers have been processed. pContext can be used to attach application-specific data to a buffer. This argument will be returned unmodified along with the buffer when grabbing is done.

GENAPIC_RESULT PylonStreamGrabberRegisterBuffer ( PYLON_STREAMGRABBER_HANDLE  hStg,
void *  pBuffer,
size_t  BufLen,
PYLON_STREAMBUFFER_HANDLE phBuf 
)

Attach an image data buffer to a stream grabber.

Parameters
[in]hStgStream grabber handle
[in]pBufferData buffer pointer
[in]BufLenData buffer size
[out]phBufPointer to buffer handle result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Register a data buffer with a stream grabber. This must be done before the buffer can be used to receive data.

GENAPIC_RESULT PylonStreamGrabberRetrieveResult ( PYLON_STREAMGRABBER_HANDLE  hStg,
PylonGrabResult_t pGrabResult,
_Bool *  pReady 
)

Retrieve buffer after processing by stream grabber.

Parameters
[in]hStgStream grabber handle
[out]pGrabResultPointer to result data struct
[out]pReadyPointer to 'buffer ready' flag
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Calling this function returns a boolean status in the variable pointed to by pReady , indicating whether at least one data buffer has been filled with data. If so, information about the first of such buffers is returned in the result structpointed to by pGrabResult.

GENAPIC_RESULT PylonStreamGrabberSetMaxBufferSize ( PYLON_STREAMGRABBER_HANDLE  hStg,
size_t  maxSize 
)

Set the maximum data buffer size for a stream grabber.

Parameters
[in]hStgStream grabber handle
[in]maxSizeBuffer size to set
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function is used to prepare a stream grabber for grabbing. It sets up the maximum size of any individual data buffer that will be used to grab data.

GENAPIC_RESULT PylonStreamGrabberSetMaxNumBuffer ( PYLON_STREAMGRABBER_HANDLE  hStg,
size_t  numBuffers 
)

Set the maximum number of data buffers for a stream grabber to use.

Parameters
[in]hStgStream grabber handle
[in]numBuffersBuffer count to set
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function is used to prepare a stream grabber for grabbing. It sets up the maximum number of buffers that will be used to grab data.

GENAPIC_RESULT PylonTerminate ( void  )

Shut down the pylon C runtime system.

Returns
GENAPI_E_OK This function is guaranteed not to fail.

Call this function when you are done using pylon C. Its purpose is to deallocate structures used by pylon C internally. After calling this function, no more pylon C functions may be called unless another call to PylonInitialize() is made first.

GENAPIC_RESULT PylonWaitObjectCreate ( PYLON_WAITOBJECT_HANDLE phWobj)

Create a user-controllable wait object.

Parameters
[out]phWobjPointer to wait variable receiving wait object set handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for a newly-created empty wait object.

GENAPIC_RESULT PylonWaitObjectDestroy ( PYLON_WAITOBJECT_HANDLE  hWobj)

Get rid of a user-controllable wait object.

Parameters
[in]hWobjWait object handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function deletes a wait object. Only wait objects created via PylonWaitObjectCreate() can be deleted by this function.

GENAPIC_RESULT PylonWaitObjectFromFd ( int  fd,
PYLON_WAITOBJECT_HANDLE phWobj 
)

Create a wait object for an existing Linux file descriptor.

Parameters
[in]fdLinux file descriptor
[out]phWobjPointer to PYLON_WAITOBJECT_HANDLE result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

This function creates a wait object from a Linux file descriptor that is usable with the select() or poll() function (timer by timerfd_create(), event by eventfd(), etc.). The file descriptor is internally duplicated so that the original one will not be closed.

GENAPIC_RESULT PylonWaitObjectGetFd ( PYLON_WAITOBJECT_HANDLE  hWobj,
int *  pFd 
)

Return the Linux file descriptor of a wait object.

Parameters
[in]hWobjWait object handle
[out]pFdPointer to the Linux file descriptor result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes. one of the documented error codes otherwise

This function returns the Linux file descriptor owned by the wait object. The file descriptor returned is still owned by the wait object, so do not close it.

GENAPIC_RESULT PylonWaitObjectIsValid ( PYLON_WAITOBJECT_HANDLE  hWobj,
_Bool *  pValid 
)

Return the boolean 'valid' status of a stream grabber.

Parameters
[in]hWobjWait object handle
[out]pValidPointer to boolean 'valid' flag result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Check, whether a wait object is fully initialized and ready to be used.

GENAPIC_RESULT PylonWaitObjectReset ( PYLON_WAITOBJECT_HANDLE  hWobj)

Reset a wait object to the 'not signaled' state.

Parameters
[in]hWobjWait object handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function sets a wait object to the 'not signaled' state.

GENAPIC_RESULT PylonWaitObjectsAdd ( PYLON_WAITOBJECTS_HANDLE  hWos,
PYLON_WAITOBJECT_HANDLE  hWobj,
size_t *  pIndex 
)

Add a single wait object to a wait object set.

Parameters
[in]hWosWait object set
[in]hWobjWait object to add
[out]pIndexPointer to index of wait object added. If NULL, no index will be returned.
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Attach a single wait object to a wait object set.

GENAPIC_RESULT PylonWaitObjectsAddMany ( PYLON_WAITOBJECTS_HANDLE  hWos,
size_t  numWaitObjects,
  ... 
)

Add multiple wait objects to a wait object set.

Parameters
[in]hWosWait object set
[in]numWaitObjectsNumber of wait objects to add
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Attach a number of wait objects to a wait object set.

GENAPIC_RESULT PylonWaitObjectsCreate ( PYLON_WAITOBJECTS_HANDLE phWos)

Create a wait object set.

Parameters
[out]phWosPointer to wait variable receiving wait object set handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function returns a handle for a newly-created empty wait object set.

GENAPIC_RESULT PylonWaitObjectsDestroy ( PYLON_WAITOBJECTS_HANDLE  hWos)

Destroy a wait object set.

Parameters
[out]hWosWait object set handle to delete
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function deletes a wait object set.

GENAPIC_RESULT PylonWaitObjectSignal ( PYLON_WAITOBJECT_HANDLE  hWobj)

Set a wait object to the 'signaled' state.

Parameters
[in]hWobjWait object handle
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

This function sets a wait object to the 'signaled' state.

GENAPIC_RESULT PylonWaitObjectsRemoveAll ( PYLON_WAITOBJECTS_HANDLE  hWos)

Remove all wait objects from a wait object set.

Parameters
[in]hWosWait object set
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

All wait objects that are currently attached to a wait object set are detached from it.

GENAPIC_RESULT PylonWaitObjectsWaitForAll ( PYLON_WAITOBJECTS_HANDLE  hWos,
uint32_t  timeout,
_Bool *  pResult 
)

Wait for all objects in a wait object set to become signaled.

Parameters
[in]hWosWait object set handle
[in]timeoutMax. time to wait in ms
[out]pResultPointer to boolean return value
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait until either all wait objects in the set become signaled or the timeout expires. The boolean return value pointed to by pResult indicates which one is the case: True - signaled, false - timeout.

GENAPIC_RESULT PylonWaitObjectsWaitForAllEx ( PYLON_WAITOBJECTS_HANDLE  hWos,
uint32_t  timeout,
_Bool  alertable,
EPylonWaitExResult pWaitResult 
)

Wait for all objects in a wait object set to become signaled.

Parameters
[in]hWosWait object set handle
[in]timeoutMax. time to wait in ms
[in]alertableBoolean flag selecting alertable or non-alertable wait
[out]pWaitResultPointer to return value
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait until either all wait objects in the set become signaled or the timeout expires. The return value pointed to by pWaitResult indicates the reason why the function returned. The alertable argument, if set to one, allows the wait to be interrupted.

GENAPIC_RESULT PylonWaitObjectsWaitForAny ( PYLON_WAITOBJECTS_HANDLE  hWos,
uint32_t  timeout,
size_t *  pIndex,
_Bool *  pResult 
)

Wait for any one object in a wait object set to become signaled.

Parameters
[in]hWosWait object set handle
[in]timeoutMax. time to wait in ms
[out]pIndexPointer to index of wait object signaled
[out]pResultPointer to boolean return value
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait until either any one of the wait objects in the set becomes signaled or the timeout expires. The boolean return value pointed to by pResult indicates which one is the case: True - signaled, false - timeout. The variable pointed to by pIndex is set to the index of the wait object that has been signaled.

GENAPIC_RESULT PylonWaitObjectsWaitForAnyEx ( PYLON_WAITOBJECTS_HANDLE  hWos,
uint32_t  timeout,
size_t *  pIndex,
_Bool  alertable,
EPylonWaitExResult pWaitResult 
)

Wait for any one object in a wait object set to become signaled.

Parameters
[in]hWosWait object set handle
[in]timeoutMax. time to wait in ms
[out]pIndexPointer to index of wait object signaled
[in]alertableBool: wait can be interrupted
[out]pWaitResultPointer to return value
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait until either any one of the wait objects in the set becomes signaled or the timeout expires. The return value pointed to by pWaitResult indicates the reason why the function returned. The variable pointed to by pIndex is set to the index of the wait object that has been signaled. The alertable argument, if set to one, allows the wait to be interrupted.

GENAPIC_RESULT PylonWaitObjectWait ( PYLON_WAITOBJECT_HANDLE  hWobj,
uint32_t  timeout,
_Bool *  pResult 
)

Wait on a wait object.

Parameters
[in]hWobjWait object handle
[in]timeoutMax. time to wait in ms
[out]pResultPointer to boolean return value
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait until either the wait object becomes signaled or the timeout expires. The boolean return value pointed to by pResult indicates which on is the case: True - signaled, false - timeout.

GENAPIC_RESULT PylonWaitObjectWaitEx ( PYLON_WAITOBJECT_HANDLE  hWobj,
uint32_t  timeout,
_Bool  alertable,
EPylonWaitExResult pWaitResult 
)

Extended wait on a wait object.

Parameters
[in]hWobjWait object handle
[in]timeoutMax. time to wait in ms
[in]alertableBoolean flag selecting alertable or non-alertable wait
[out]pWaitResultPointer to wait result
Returns
If the function succeeds, the return value is GENAPI_E_OK.
If the function fails, the return value will be any of error codes described in the section Error Codes.

Wait, until either the wait object becomes signaled or the timeout expires. The boolean return value pointed to by pResult indicates which on is the case: True - signaled, false - timeout. The alertable argument, if set to one, allows the wait to be interrupted. This is an extended version of PylonWaitObjectWait().


pylon C 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:26)