Serial Framework
ContentsIndexHome
PreviousUpNext
TwclSerialConfig Record

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

Syntax
Pascal
TwclSerialConfig = record
  BaudRate: Cardinal;
  ParityCheck: Boolean;
  OutxCtsFlow: Boolean;
  OutxDsrFlow: Boolean;
  DtrControl: TwclSerialDtrControl;
  DsrSensitivity: Boolean;
  TXContinueOnXoff: Boolean;
  OutX: Boolean;
  InX: Boolean;
  ErrorCharReplace: Boolean;
  NullStrip: Boolean;
  RtsControl: TwclSerialRtsControl;
  AbortOnError: Boolean;
  XonLim: Word;
  XoffLim: Word;
  ByteSize: Byte;
  Parity: TwclSerialParity;
  StopBits: TwclSerialStopBits;
  XonChar: AnsiChar;
  XoffChar: AnsiChar;
  ErrorChar: AnsiChar;
  EofChar: AnsiChar;
  EvtChar: AnsiChar;
end;
Members 
Description 
BaudRate: Cardinal; 
Specifies the baud at which the communications device operates. This member can be an actual baud value, or a baud index.  
ParityCheck: Boolean; 
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.  
OutxCtsFlow: Boolean; 
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.  
OutxDsrFlow: Boolean; 
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.  
DtrControl: TwclSerialDtrControl; 
Specifies the DTR (data-terminal-ready) input flow control.  
DsrSensitivity: Boolean; 
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.  
TXContinueOnXoff: Boolean; 
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.  
OutX: Boolean; 
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.  
InX: Boolean; 
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.  
ErrorCharReplace: Boolean; 
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.  
NullStrip: Boolean; 
Specifies whether null bytes are discarded. If this member is True, null bytes are discarded when received.  
RtsControl: TwclSerialRtsControl; 
Specifies the RTS (request-to-send) input flow control.  
AbortOnError: Boolean; 
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.  
XonLim: Word; 
Specifies the minimum number of bytes allowed in the input buffer before the XON character is sent.  
XoffLim: Word; 
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.  
ByteSize: Byte; 
The number of bits in the bytes transmitted and received.  
Parity: TwclSerialParity; 
Specifies the parity scheme to be used.  
StopBits: TwclSerialStopBits; 
Specifies the number of stop bits to be used.  
XonChar: AnsiChar; 
Specifies the value of the XON character for both transmission and reception.  
XoffChar: AnsiChar; 
Specifies the value of the XOFF character for both transmission and reception.  
ErrorChar: AnsiChar; 
Specifies the value of the character used to replace bytes received with a parity error.  
EofChar: AnsiChar; 
Specifies the value of the character used to signal the end of data.  
EvtChar: AnsiChar; 
Specifies the value of the character used to cause the evRxFlag event.  
Copyright (c) 2006-2019. All rights reserved.