Buffer Interface
Macros | Typedefs | Functions
clallserial.h File Reference

Go to the source code of this file.

Macros

#define USER_EXTERN_C
 
#define CLALLSERIALEXPORT   USER_EXTERN_C __declspec(dllimport)
 
#define CLALLSERIALCC   __stdcall
 
#define _CL_hSerRef_DEFINED_
 
#define _CL_INT32_DEFINED_
 
#define _CL_UINT32_DEFINED_
 
#define _CL_INT8_DEFINED_
 
#define CL_DLL_VERSION_NO_VERSION   1
 
#define CL_DLL_VERSION_1_0   2
 
#define CL_DLL_VERSION_1_1   3
 
#define CL_BAUDRATE_9600   1
 
#define CL_BAUDRATE_19200   2
 
#define CL_BAUDRATE_38400   4
 
#define CL_BAUDRATE_57600   8
 
#define CL_BAUDRATE_115200   16
 
#define CL_BAUDRATE_230400   32
 
#define CL_BAUDRATE_460800   64
 
#define CL_BAUDRATE_921600   128
 
#define CL_ERR_NO_ERR   0
 
#define CL_ERR_BUFFER_TOO_SMALL   -10001
 
#define CL_ERR_MANU_DOES_NOT_EXIST   -10002
 
#define CL_ERR_PORT_IN_USE   -10003
 
#define CL_ERR_TIMEOUT   -10004
 
#define CL_ERR_INVALID_INDEX   -10005
 
#define CL_ERR_INVALID_REFERENCE   -10006
 
#define CL_ERR_ERROR_NOT_FOUND   -10007
 
#define CL_ERR_BAUD_RATE_NOT_SUPPORTED   -10008
 
#define CL_ERR_OUT_OF_MEMORY   -10009
 
#define CL_ERR_REGISTRY_KEY_NOT_FOUND   -10010
 
#define CL_ERR_INVALID_PTR   -10011
 
#define CL_ERR_UNABLE_TO_LOAD_DLL   -10098
 
#define CL_ERR_FUNCTION_NOT_FOUND   -10099
 

Typedefs

typedef void * hSerRef
 
typedef int CLINT32
 
typedef unsigned int CLUINT32
 
typedef char CLINT8
 

Functions

CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clFlushPort (hSerRef serialRef)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetErrorText (const CLINT8 *manuName, CLINT32 errorCode, CLINT8 *errorText, CLUINT32 *errorTextSize)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetNumPorts (CLUINT32 *Ports)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetNumBytesAvail (hSerRef serialRef, CLUINT32 *numBytes)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetPortInfo (CLUINT32 serialIndex, CLINT8 *manufacturerName, CLUINT32 *nameBytes, CLINT8 *portID, CLUINT32 *IDBytes, CLUINT32 *version)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetSupportedBaudRates (hSerRef serialRef, CLUINT32 *baudRates)
 
CLALLSERIALEXPORT void CLALLSERIALCC clSerialClose (hSerRef serialRef)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialInit (CLUINT32 serialIndex, hSerRef *serialRefPtr)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialRead (hSerRef serialRef, CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeout)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialWrite (hSerRef serialRef, CLINT8 *buffer, CLUINT32 *bufferSize, CLUINT32 serialTimeout)
 
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSetBaudRate (hSerRef serialRef, CLUINT32 baudRate)
 

Macro Definition Documentation

#define _CL_hSerRef_DEFINED_
#define _CL_INT32_DEFINED_
#define _CL_INT8_DEFINED_
#define _CL_UINT32_DEFINED_
#define CL_BAUDRATE_115200   16
#define CL_BAUDRATE_19200   2
#define CL_BAUDRATE_230400   32
#define CL_BAUDRATE_38400   4
#define CL_BAUDRATE_460800   64
#define CL_BAUDRATE_57600   8
#define CL_BAUDRATE_921600   128
#define CL_BAUDRATE_9600   1
#define CL_DLL_VERSION_1_0   2
#define CL_DLL_VERSION_1_1   3
#define CL_DLL_VERSION_NO_VERSION   1
#define CL_ERR_BAUD_RATE_NOT_SUPPORTED   -10008
#define CL_ERR_BUFFER_TOO_SMALL   -10001
#define CL_ERR_ERROR_NOT_FOUND   -10007
#define CL_ERR_FUNCTION_NOT_FOUND   -10099
#define CL_ERR_INVALID_INDEX   -10005
#define CL_ERR_INVALID_PTR   -10011
#define CL_ERR_INVALID_REFERENCE   -10006
#define CL_ERR_MANU_DOES_NOT_EXIST   -10002
#define CL_ERR_NO_ERR   0
#define CL_ERR_OUT_OF_MEMORY   -10009
#define CL_ERR_PORT_IN_USE   -10003
#define CL_ERR_REGISTRY_KEY_NOT_FOUND   -10010
#define CL_ERR_TIMEOUT   -10004
#define CL_ERR_UNABLE_TO_LOAD_DLL   -10098
#define CLALLSERIALCC   __stdcall
#define CLALLSERIALEXPORT   USER_EXTERN_C __declspec(dllimport)
#define USER_EXTERN_C

Typedef Documentation

typedef int CLINT32
typedef char CLINT8
typedef unsigned int CLUINT32
typedef void* hSerRef

Function Documentation

CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clFlushPort ( hSerRef  serialRef)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetErrorText ( const CLINT8 manuName,
CLINT32  errorCode,
CLINT8 errorText,
CLUINT32 errorTextSize 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetNumBytesAvail ( hSerRef  serialRef,
CLUINT32 numBytes 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetNumPorts ( CLUINT32 Ports)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetPortInfo ( CLUINT32  serialIndex,
CLINT8 manufacturerName,
CLUINT32 nameBytes,
CLINT8 portID,
CLUINT32 IDBytes,
CLUINT32 version 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clGetSupportedBaudRates ( hSerRef  serialRef,
CLUINT32 baudRates 
)
CLALLSERIALEXPORT void CLALLSERIALCC clSerialClose ( hSerRef  serialRef)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialInit ( CLUINT32  serialIndex,
hSerRef serialRefPtr 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialRead ( hSerRef  serialRef,
CLINT8 buffer,
CLUINT32 bufferSize,
CLUINT32  serialTimeout 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSerialWrite ( hSerRef  serialRef,
CLINT8 buffer,
CLUINT32 bufferSize,
CLUINT32  serialTimeout 
)
CLALLSERIALEXPORT CLINT32 CLALLSERIALCC clSetBaudRate ( hSerRef  serialRef,
CLUINT32  baudRate 
)