Exported C functions as defined by the Camera Link standard v1.1. More...
#include <CLProtocol/ClSerialTypes.h>
Include dependency graph for ClSerial.h:
Go to the source code of this file.
Macros | |
| #define | CLSERIALCC __attribute__((cdecl)) |
| #define | CLSERIALEXPORT USER_EXTERN_C __attribute__((visibility("default"))) |
| #define | USER_EXTERN_C |
Functions | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetManufacturerInfo (CLINT8 *ManufacturerName, CLUINT32 *bufferSize, CLUINT32 *version) |
| This function returns the name of the manufacturer represented by the index parameter and the version of the Camera Link specifications with which the specified .dll complies. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clSerialInit (CLUINT32 serialIndex, hSerRef *serialRefPtr) |
| This function initializes the device referred to by serialIndex and returns a pointer to an internal serial reference structure. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clSerialRead (hSerRef serialRef, CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut) |
| This function reads numBytes from the serial device referred to by serialRef. clSerialRead will return when numBytes are available at the serial port or when the serialTimeout period has passed. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clSerialWrite (hSerRef serialRef, CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeOut) |
| This function writes the data in the buffer to the serial device referenced by serialRef. More... | |
| CLSERIALEXPORT void CLSERIALCC | clSerialClose (hSerRef serialRef) |
| This function closes the serial device and cleans up the resources associated with serialRef. Upon return, serialRef is no longer usable. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetNumSerialPorts (CLUINT32 *numSerialPorts) |
| This function returns the number of serial ports in your system from a specified manufacturer. Use this number to determine the number of times you should loop through the clGetSerialPortIdentifier function. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetSerialPortIdentifier (CLUINT32 serialIndex, CLINT8 *PortID, CLUINT32 *bufferSize) |
| is passed. On successful return, this parameter contains the number of bytes written into the buffer, including the NULL termination character. On CL_ERR_BUFFER_TOO_SMALL, this parameter contains the size of the buffer needed to write the data text. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetNumBytesAvail (hSerRef serialRef, CLUINT32 *numBytes) |
| This function will output how many bytes have are available at the port specified by serialRef. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clFlushPort (hSerRef serialRef) |
| This function will discard any bytes that are available in the input buffer. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetSupportedBaudRates (hSerRef serialRef, CLUINT32 *baudRates) |
| This function returns the valid baud rates of the current interface. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clSetBaudRate (hSerRef serialRef, CLUINT32 baudRate) |
| This function sets the baud rate for the serial port of the selected device. Use clGetSupportedBaudRate to determine supported baud rates. More... | |
| CLSERIALEXPORT CLINT32 CLSERIALCC | clGetErrorText (CLINT32 errorCode, CLINT8 *errorText, CLUINT32 *errorTextSize) |
| This function converts an error code to error text for display in a dialog box or in a standard I/O window. More... | |
Detailed Description
Exported C functions as defined by the Camera Link standard v1.1.
Definition in file ClSerial.h.
Macro Definition Documentation
◆ CLSERIALCC
| #define CLSERIALCC __attribute__((cdecl)) |
Definition at line 64 of file ClSerial.h.
◆ CLSERIALEXPORT
| #define CLSERIALEXPORT USER_EXTERN_C __attribute__((visibility("default"))) |
Definition at line 54 of file ClSerial.h.
◆ USER_EXTERN_C
| #define USER_EXTERN_C |
Definition at line 41 of file ClSerial.h.