Serial Framework
ContentsIndexHome
PreviousUpNext
wclSerial::wclSerialConfig Structure

The structure describes a serial device (COM port) configuration settings that is used to open the COM port.

Syntax
C++
typedef struct {
  unsigned long BaudRate;
  bool ParityCheck;
  bool OutxCtsFlow;
  bool OutxDsrFlow;
  wclSerialDtrControl DtrControl;
  bool DsrSensitivity;
  bool TXContinueOnXoff;
  bool OutX;
  bool InX;
  bool ErrorCharReplace;
  bool NullStrip;
  wclSerialRtsControl RtsControl;
  bool AbortOnError;
  unsigned short XonLim;
  unsigned short XoffLim;
  unsigned char ByteSize;
  wclSerialParity Parity;
  wclSerialStopBits StopBits;
  char XonChar;
  char XoffChar;
  char ErrorChar;
  char EofChar;
  char EvtChar;
} wclSerialConfig;
Members 
Description 
unsigned long BaudRate; 
Specifies the baud at which the communications device operates. This member can be an actual baud value, or a baud index.  
bool ParityCheck; 
Specifies whether parity checking is enabled. If this member is True, parity checking is performed and parity errors are reported. This should not be confused with the Parity member, which controls the type of parity used in communications.  
bool OutxCtsFlow; 
Specifies whether the CTS (clear-to-send) signal is monitored for output flow control. If this member is True and CTS is low, output is suspended until CTS is high again. The CTS signal is under control of the DCE (usually a modem), the DTE (usually the PC) simply monitors the status of this signal, the DTE does not change it.  
bool OutxDsrFlow; 
Specifies whether the DSR (data-set-ready) signal is monitored for output flow control. If this member is True and DSR is low, output is suspended until DSR is high again. Once again, this signal is under the control of the DCE; the DTE only monitors this signal.  
wclSerialDtrControl DtrControl; 
Specifies the DTR (data-terminal-ready) input flow control.  
bool DsrSensitivity; 
Specifies whether the communications driver is sensitive to the state of the DSR signal. If this member is True the driver ignores any bytes received, unless the DSR modem input line is high.  
bool TXContinueOnXoff; 
Specifies whether transmission stops when the input buffer is full and the driver has transmitted the XOFF character. If this member is True, transmission continues after the XOFF character has been sent. If this member is False, transmission does not continue until the input buffer is within XonLim bytes of being empty and the driver has transmitted the XON character.  
bool OutX; 
Specifies whether XON/XOFF flow control is used during transmission. If this member is True, transmission stops when the XOFF character is received and starts again when the XON character is received.  
bool InX; 
Specifies whether XON/XOFF flow control is used during reception. If this member is True, the XOFF character is sent when the input buffer comes within XoffLim bytes of being full, and the XON character is sent when the input buffer comes within XonLim bytes of being empty.  
bool ErrorCharReplace; 
Specifies whether bytes received with parity errors are replaced with the character specified by the ErrorChar member. If this member is True and the Parity member is True, replacement occurs.  
bool NullStrip; 
Specifies whether null bytes are discarded. If this member is True, null bytes are discarded when received.  
wclSerialRtsControl RtsControl; 
Specifies the RTS (request-to-send) input flow control.  
bool AbortOnError; 
Specifies whether read and write operations are terminated if an error occurs. If this member is True, the driver terminates all read and write operations with an error status if an error occurs. The driver will not accept any further communications operations until the application has acknowledged.  
unsigned short XonLim; 
Specifies the minimum number of bytes allowed in the input buffer before the XON character is sent.  
unsigned short XoffLim; 
Specifies the maximum number of bytes allowed in the input buffer before the XOFF character is sent. The maximum number of bytes allowed is calculated by subtracting this value from the size, in bytes, of the input buffer.  
unsigned char ByteSize; 
The number of bits in the bytes transmitted and received.  
wclSerialParity Parity; 
Specifies the parity scheme to be used.  
wclSerialStopBits StopBits; 
Specifies the number of stop bits to be used.  
char XonChar; 
Specifies the value of the XON character for both transmission and reception.  
char XoffChar; 
Specifies the value of the XOFF character for both transmission and reception.  
char ErrorChar; 
Specifies the value of the character used to replace bytes received with a parity error.  
char EofChar; 
Specifies the value of the character used to signal the end of data.  
char EvtChar; 
Specifies the value of the character used to cause the evRxFlag event.  
Copyright (c) 2006-2017. All rights reserved.