Serial Framework C++ Edition
Classes | Typedefs | Enumerations | Functions | Variables
wclSerial Namespace Reference

Classes

class  CwclSerialClient
 The component represents a Serial Client connection. More...
 
class  CwclSerialMonitor
 The Serial Monitor allows your application to enumerate available serial devices and to monitor changes in its configuration. More...
 
class  CwclUsbMonitor
 The USB Monitor allows your application to enumerate available USB devices and to monitor changes in its configuration. More...
 
struct  wclSerialConfig
 The structure describes a serial device (COM port) configuration settings that is used to open the COM port. More...
 
struct  wclSerialDevice
 The record contains information about serial device. More...
 
struct  wclSerialFeatures
 Contains communications driver features information. More...
 
struct  wclSerialTimeouts
 Contains the time-out parameters for a communications device. More...
 
struct  wclUsbDevice
 The structure contains information about USB device. More...
 

Typedefs

typedef std::set< wclSerialParitywclSerialParities
 The set of supported parities. More...
 
typedef std::set< wclSerialStopBitswclSerialStopBitsSet
 Set of the number of stop bits to be used. More...
 
typedef std::set< wclSerialPurgeFlagwclSerialPurgeFlags
 The set of flags used in PurgeComm method. More...
 
typedef std::set< wclSerialEventwclSerialEvents
 The set of the communication events. More...
 
typedef std::set< wclSerialErrorwclSerialErrors
 Set of serial device errors. More...
 
typedef std::set< wclSerialCommunicationStatewclSerialCommunicationStates
 The set contains the current communication device state. More...
 
typedef std::set< wclModemStatuswclModemStatuses
 The states of the modem control-register values. More...
 
typedef std::set< wclSerialBaudRatewclSerialBaudRates
 The serial port baud rates. More...
 
typedef std::set< wclSerialCapabilitywclSerialCapabilities
 The capabilities offered by the serial port. More...
 
typedef std::set< wclSerialParamwclSerialParams
 The set of the communications parameters that can be changed. More...
 
typedef std::set< wclSerialDataSizewclSerialDataSizes
 The set of number of data bits that can be set. More...
 
typedef std::list< wclSerialDevicewclSerialDevices
 The array contains information about found serial devices. More...
 
typedef std::list< wclUsbDevicewclUsbDevices
 The array contains list of found USB devices. More...
 

Enumerations

enum  wclSerialDtrControl { dtrControlDisable, dtrControlEnable, dtrControlHandshake }
 Specifies the DTR (data-terminal-ready) input flow control. More...
 
enum  wclSerialRtsControl { rtsControlDisable, rtsControlEnable, rtsControlHandshake, rtsControlToggle }
 Specifies the RTS (request-to-send) input flow control. More...
 
enum  wclSerialParity {
  spNo, spOdd, spEven, spMark,
  spSpace
}
 Specifies the parity scheme to be used. More...
 
enum  wclSerialStopBits { sbOne, sbOne5, sbTwo }
 Specifies the number of stop bits to be used. More...
 
enum  wclSerialPurgeFlag { purgeRxAbort, purgeRxClear, purgeTxAbort, purgeTxClear }
 The flags used in PurgeConmm method. More...
 
enum  wclSerialEscapeFunction {
  escClrBreak, escClrDtr, escClrRts, escSetBreak,
  escSetDtr, escSetRts, escSetXoff, escSetXon
}
 The extended function to be performed by the EscapeCommFunction method. More...
 
enum  wclSerialEvent {
  evBreak, evCts, evDsr, evRing,
  evRlsd, evChar
}
 The type of a serial device event. More...
 
enum  wclSerialError {
  erBreak, erFrame, erOverrun, erRxOver,
  erRxParity
}
 The serial errors. More...
 
enum  wclSerialCommunicationState {
  csCtsHold, csDsrHold, csRlsdHold, csXoffHold,
  csXoffSent, csEof, csTxim
}
 The enumeration describes state of the serial communication device. More...
 
enum  wclModemStatus { msCtsOn, msDsrOn, msRingOn, msRlsdOn }
 The state of the modem control-register value. More...
 
enum  wclSerialBaudRate {
  br075, br110, br134_5, br150,
  br300, br600, br1200, br1800,
  br2400, br4800, br7200, br9600,
  br14400, br19200, br38400, br56K,
  br57600, br115200, br128K, brUser
}
 The maximum allowable baud rate, in bits per second (bps). More...
 
enum  wclSerialType {
  stFax, stLat, stModem, stNetworkBridge,
  stParallelPort, stRS232, stRS422, stRS423,
  stRS449, stScanner, stTcpIpTelNet, stX25,
  stUnspecified
}
 The communications-provider type. More...
 
enum  wclSerialCapability {
  sc16BitMode, scDtrDsr, scIntervalTimeouts, scParityCheck,
  scRlsd, scRtsCts, scSetXChar, scSpecialChars,
  scTotalTimeouts, scXOnXoff
}
 The possible serial port capabilities. More...
 
enum  wclSerialParam {
  spBaud, spDataBits, spHandshaking, spParity,
  spParityCheck, sRlsd, spStopBits
}
 The communications parameters that can be changed. More...
 
enum  wclSerialDataSize {
  sdFive, sdSix, sdSeven, sdEight,
  sdSixteen, sdWide
}
 The number of data bits that can be set. More...
 

Functions

int wclReadDeviceInformation (const tstring &Instance, wclSerialDevice &Device)
 Helper function that reads serial device information by its Device Instance ID. More...
 

Variables

const int WCL_E_SERIAL_BASE = 0x00060000
 The base error code for Serial Framework errors. More...
 
const int WCL_E_SERIAL_UNABLE_OPEN_DEVICE_KEY = WCL_E_SERIAL_BASE + 0x0000
 The device's registry key was not found or not enough privilegies. More...
 
const int WCL_E_SERIAL_UNABLE_READ_FRIENDLY_NAME = WCL_E_SERIAL_BASE + 0x0001
 Unable to read a device's friendly name. More...
 
const int WCL_E_SERIAL_UNABLE_OPEN_DEVICE_PARAMETERS_KEY = WCL_E_SERIAL_BASE + 0x0002
 The device's parameters registry key was not found or not enough privilegies. More...
 
const int WCL_E_SERIAL_UNABLE_READ_PORT_NAME = WCL_E_SERIAL_BASE + 0x0003
 Unable to read a device's port name. More...
 
const int WCL_E_SERIAL_DEVICE_CLASS_NOT_FOUND = WCL_E_SERIAL_BASE + 0x0004
 The given Device Class Guid was not found. More...
 
const int WCL_E_SERIAL_MONITORING_RUNNING = WCL_E_SERIAL_BASE + 0x0005
 Monitoring is running. More...
 
const int WCL_E_SERIAL_MONITORING_NOT_RUNNING = WCL_E_SERIAL_BASE + 0x0006
 Monitoring is not running. More...
 
const int WCL_E_SERIAL_UNABLE_GET_READ_BUFFER = WCL_E_SERIAL_BASE + 0x0007
 Unable to get read buffer size. More...
 
const int WCL_E_SERIAL_UNABLE_GET_WRITE_BUFFER = WCL_E_SERIAL_BASE + 0x0008
 Unable to get write buffer size. More...
 
const int WCL_E_SERIAL_UNABLE_SET_READ_BUFFER = WCL_E_SERIAL_BASE + 0x0009
 Unable to set read buffer size. More...
 
const int WCL_E_SERIAL_UNABLE_SET_WRITE_BUFFER = WCL_E_SERIAL_BASE + 0x000A
 Unable to set write buffer size. More...
 
const int WCL_E_SERIAL_UNABLE_INIT_OVERLAPPED_OPERATION = WCL_E_SERIAL_BASE + 0x000B
 Unable to initialize the overlapped IO operation. More...
 
const int WCL_E_SERIAL_WRITE_FAILED = WCL_E_SERIAL_BASE + 0x000C
 Write data to the serial port was failed. More...
 
const int WCL_E_SERIAL_WRITE_TIMEOUT = WCL_E_SERIAL_BASE + 0x000D
 Timeout appeared during write operation. That doe snot mean real error. That just means that some bytes were sent but time out appeared before all bytes are sent. You can retry to send remaining bytes or terminate connection. More...
 
const int WCL_E_SERIAL_DEVICE_REMOVED = WCL_E_SERIAL_BASE + 0x000E
 A serial device has been removed. More...
 
const int WCL_E_SERIAL_UNABLE_GET_COMM_CONFIGURATION = WCL_E_SERIAL_BASE + 0x000F
 Unable to read COM port configuration. More...
 
const int WCL_E_SERIAL_UNABLE_SET_COMM_CONFIGURATION = WCL_E_SERIAL_BASE + 0x0010
 Unable to write COM port configuration. More...
 
const int WCL_E_SERIAL_UNABLE_GET_COMM_TIMEOUTS = WCL_E_SERIAL_BASE + 0x0011
 Unable to read COM port timeouts. More...
 
const int WCL_E_SERIAL_UNABLE_SET_COMM_TIMEOUTS = WCL_E_SERIAL_BASE + 0x0012
 Unable to write COM port timeouts. More...
 
const int WCL_E_SERIAL_UNABLE_CREATE_OVERLAPPED_EVENT = WCL_E_SERIAL_BASE + 0x0013
 Unable create overlapped operation event. More...
 
const int WCL_E_SERIAL_UNABLE_OPEN_PORT = WCL_E_SERIAL_BASE + 0x0014
 Unable to open the specified COM port. More...
 
const int WCL_E_SERIAL_UNABLE_CLEAR_BUFFERS = WCL_E_SERIAL_BASE + 0x0015
 Unable clear input and output buffers. More...
 
const int WCL_E_SERIAL_UNABLE_SET_EVENTS_MASK = WCL_E_SERIAL_BASE + 0x0016
 Unable to set COM potr events mask. More...
 
const int WCL_E_SERIAL_PURGE_COMM_FAILED = WCL_E_SERIAL_BASE + 0x0017
 The PurgeComm operation was failed. More...
 
const int WCL_E_SERIAL_ESCAPE_COMM_FUNCTION_FAILED = WCL_E_SERIAL_BASE + 0x0018
 The EscapeCommFunction has been failed. More...
 
const int WCL_E_SERIAL_SET_COMM_BREAK_FAILED = WCL_E_SERIAL_BASE + 0x0019
 The SetCommBreak method failed. More...
 
const int WCL_E_SERIAL_CLEAR_COMM_BREAK_FAILED = WCL_E_SERIAL_BASE + 0x001A
 The ClearCommBreak method failed. More...
 
const int WCL_E_SERIAL_TRANSMIT_COMM_CHAR_FAILED = WCL_E_SERIAL_BASE + 0x001B
 The TransmitCommChar method failed. More...
 
const int WCL_E_SERIAL_FLUSH_BUFFERS_FAILED = WCL_E_SERIAL_BASE + 0x001C
 The FlushBuffers method failed. More...
 
const int WCL_E_SERIAL_GET_MODEM_STATUS_FAILED = WCL_E_SERIAL_BASE + 0x001D
 The GetCommStatus method failed. More...
 
const int WCL_E_SERIAL_READ_ERROR = WCL_E_SERIAL_BASE + 0x001E
 Read operation failed. More...
 
const int WCL_E_SERIAL_UNABLE_CREATE_RESTART_EVENT = WCL_E_SERIAL_BASE + 0x001F
 Unable create communication restart event. More...
 
const int WCL_E_SERIAL_DEVICE_WRITE_TIMEOUT = WCL_E_SERIAL_BASE + 0x0020
 Write operation was timed out on wait. Probably device is disconnected or not available. More...
 
const int WCL_E_SERIAL_CFGMGR_DLL_NOT_FOUND = WCL_E_SERIAL_BASE + 0x0021
 Configuration Manager DLL was not found. More...
 
const int WCL_E_SERIAL_CFGMGR_NOT_AVAILABLE = WCL_E_SERIAL_BASE + 0x0022
 Required Configuration Manager functions (API) are not available. More...
 
const int WCL_E_SERIAL_UNABLE_GET_DEVICE_NODE = WCL_E_SERIAL_BASE + 0x0023
 Unable to locate specified device's node. More...
 
const int WCL_E_SERIAL_DEVICE_INTERFACES_NOT_FOUND = WCL_E_SERIAL_BASE + 0x0024
 No one device's interface was found for specified device's instance ID. More...
 
const int WCL_E_SERIAL_DEVICE_SWITCH_FAILED = WCL_E_SERIAL_BASE + 0x0025
 Unable to switch (disable or enable) specified USB (serial) devices. More...
 
const int WCL_E_SERIAL_UNABLE_GET_COMM_FEATURES = WCL_E_SERIAL_BASE + 0x0026
 COM features read failed. More...
 
const int WCL_E_USB_MONITOR_BASE = WCL_E_SERIAL_BASE + 0x1000
 The base erorr code for USB monitor errors. More...
 
const int WCL_E_USB_MONITOR_DEVICE_CLASS_NOT_FOUND = WCL_E_USB_MONITOR_BASE + 0x0000
 No USB devices found on this system. More...
 
const int WCL_E_USB_MONITORING_RUNNING = WCL_E_USB_MONITOR_BASE + 0x0001
 Monitoring is running. More...
 
const int WCL_E_USB_MONITORING_NOT_RUNNING = WCL_E_USB_MONITOR_BASE + 0x0002
 Monitoring is not running. More...