TwclSerialClient Class

The component represents a Serial Client connection.

Namespace: wclSerialClients
TComponent
  wclSerialClients.TwclSerialClient
type
 TwclSerialClient = class(TComponent)
 end;

The TwclSerialClient type exposes the following members.

Show:
 NameDescription
Create(TComponent)

Create a new component.

Destroy

Frees the component.

Top
Show:
 NameDescription
DeviceName

Gets and sets the serial device name.

Processor

Gets the Data Processor created for the connection.

State

Gets the connection state.

WriteTimeout

Gets and sets the write operation timeout.

Top
Show:
 NameDescription
ClearCommBreak

Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.

Connect

Connects to a Serial Device (COM port).

Disconnect

Disconnects from the connected remote device.

DoConnect(Integer)

Fires the OnConnect event.

DoCreateProcessor(TwclClientDataConnection)

Fires the OnCreateProcessor event.

DoData(Pointer,Cardinal)

Fires the OnData event.

DoDestroyProcessor(TwclClientDataConnection)

Fires the OnDestroyProcessor event.

DoDisconnect(Integer)

Fires the OnDisconnect event.

DoError(TwclSerialErrors,TwclSerialCommunicationStates)

Fires the OnError event.

DoEvents(TwclSerialEvents)

Fires the OnEvent event.

DoReadError(Integer)

Fires the OnReadError event.

EscapeCommFunction(TwclSerialEscapeFunction)

Directs the specified communications device to perform an extended function.

FlushBuffers

Flushes the buffers and causes all buffered data to be sent to the COM port.

GetConfig(TwclSerialConfig)

Gets the current serial port settings.

GetFeatures(TwclSerialFeatures)

Gets the Serial port features.

GetModemStatus(TwclModemStatuses)

Retrieves the modem control-register values.

GetReadBufferSize(Cardinal)

Reads the read buffer size.

GetTimeouts(TwclSerialTimeouts)

Gets the current serial port timeouts.

GetWriteBufferSize(Cardinal)

Reads the write buffer size.

PurgeComm(TwclSerialPurgeFlags)

Discards all characters from the output or input buffer of a specified communications resource. It can also terminate pending read or write operations on the resource.

SetCommBreak

Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.

SetConfig(TwclSerialConfig)

Sets the new serial port configuration.

SetReadBufferSize(Cardinal)

Sets the read buffer size.

SetTimeouts(TwclSerialTimeouts)

Sets the serial port timeouts.

SetWriteBufferSize(Cardinal)

Sets the write buffer size.

TransmitCommChar(AnsiChar)

Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.

Write(Pointer,Cardinal,Cardinal)

Sends data to the connected device.

Top
Show:
 NameDescription
OnConnect

The event fires when a connection to a remote device has been completed (with or without success).

OnCreateProcessor

The event fires when connection to a remote device has been established with success to allow application provide a data processor for the connection.

OnData

The event fires when new data is received from the connected remote device.

OnDestroyProcessor

The event fires when connection to a remote device has been terminated. An application must destroy the Data Processor created for the connection.

OnDisconnect

The event fires when the remote connected device has been disconnected.

OnError

The event fires when a error occured during communication.

OnEvents

The event fires when a serial device event accoures.

OnReadError

The event fires when the error occured during read operation.

Top