FTVSPCPort Class

Contains configuration for virtual serial port.

General Names

Namespace FabulaTech.VSPC
Class Name FTVSPCPort
Assembly Name ftvspcnet
.NET Component File Name ftvspcnet.dll

Methods

Attaching to the Port
AttachAttaches to virtual serial port with non-standard name.
DetachDetaches from virtual serial port.
Reading/Writing Data
ReadReads data from the port.
ReadArrayReads array of data from the port.
WriteWrites data to the port.
WriteArrayWrites array of data to the port.
Other
AllowPortOpenAllow port open for communication application.

Properties

Modem status signals
CtsState of CTS signal.
DcdState of DCD signal.
DsrState of DSR singal.
RingState of RING singal.
Line status
BreakState of Break error.
FramingState of Framing error.
OverrunState of Overrun error.
ParityState of Parity error.
Other Properties
BitrateEmulationState of bitrate emulation flag. If TRUE, the port emulates write data transfer speed in accordance with value of bitrate communications parameter.
If FALSE, data is written to the port without any delays. FALSE by default.
InQueueBytesNumber of bytes in the data buffer available for reading.
PermanentIf TRUE, the port is created each time on system start.
Otherwise, port is created manually by application via API.
PortNameName of virtual serial port. This property should be set before calling Attach method or accessing any property. Changing it after Attach call leads to ftvspcErrorPortAttached exception. In case of this property is set in Design mode, virtual serial port will be created automatically on the start of application.
Remarks: When FTVSPCPort Class created dynamically (not by placing on form) there is no need to call the Attach method after setting of this property.
PortTypeRetrieves value of virtual serial port type.
QueryOpenAllows to react on virtual serial port opening. So, application can allow or prohibit access to the serial port.

Events

Port operation
OnBreakBreak flag changed.
OnCloseThe port has been closed by serial application.
OnOpenThe port has been opened by third-party serial application.
OnOpenBeforeAttachThe port has been opened by third-party serial application before your program calls Attach method.
OnPurgeSerial application purged all data in input and output queues.
OnQueryOpenThis event fires when third-party serial application tries to open virtual serial port.
OnRxCharThe data has been written to the port.
Port settings
OnBaudRateBaudrate communications parameter has been set.
OnDataBitsDataBits communications parameter has been set.
OnParityParity communications parameter has been set.
OnStopBitsStopBits communications parameter has been set.
OnTimeoutsTimeouts value has been set.
Signals
OnDtrDTR signal has been changed.
OnRtsRTS signal has been changed.
Flow control
OnBreakCharBREAK character has been set.
OnEofCharEOF character has been set.
OnErrorCharERROR character has been set.
OnEvtCharEVENT character has been set.
OnXoffCharXOFF character has been set.
OnXoffLimXOFFLIM value has been set.
OnXonCharXON character has been set.
OnXonLimXONLIM value has been set.
Extended flow control
OnAbortOnErrorValue of fAbortOnError member of DCB structure changed.
OnDsrSensitivityValue of fDsrSensitivity member of DCB structure changed.
OnDtrControlValue of fDtrControl member of DCB structure changed.
OnInXValue of fInX member of DCB structure changed.
OnNullValue of fNull member of DCB structure changed.
OnOutXValue of fOutX member of DCB structure changed.
OnOutxCtsFlowValue of fOutxCtsFlow member of DCB structure changed.
OnOutxDsrFlowValue of fOutxDsrFlow member of DCB structure changed.
OnRtsControlValue of fRtsControl member of DCB structure changed.
OnTXContinueOnXoffValue of fTXContinueOnXoff member of DCB structure changed.
OnUseErrorCharValue of fErrorChar member of DCB structure changed.