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 | |
|---|---|
| Attach | Attaches to virtual serial port with non-standard name. |
| Detach | Detaches from virtual serial port. |
| Reading/Writing Data | |
| Read | Reads data from the port. |
| ReadArray | Reads array of data from the port. |
| Write | Writes data to the port. |
| WriteArray | Writes array of data to the port. |
| Other | |
| AllowPortOpen | Allow port open for communication application. |
Properties
| Modem status signals | |
|---|---|
| Cts | State of CTS signal. |
| Dcd | State of DCD signal. |
| Dsr | State of DSR singal. |
| Ring | State of RING singal. |
| Line status | |
| Break | State of Break error. |
| Framing | State of Framing error. |
| Overrun | State of Overrun error. |
| Parity | State of Parity error. |
| Other Properties | |
| BitrateEmulation | State 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. |
| InQueueBytes | Number of bytes in the data buffer available for reading. |
| Permanent | If TRUE, the port is created each time on system start. Otherwise, port is created manually by application via API. |
| PortName | Name 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. |
| PortType | Retrieves value of virtual serial port type. |
| QueryOpen | Allows to react on virtual serial port opening. So, application can allow or prohibit access to the serial port. |
Events
| Port operation | |
|---|---|
| OnBreak | Break flag changed. |
| OnClose | The port has been closed by serial application. |
| OnOpen | The port has been opened by third-party serial application. |
| OnOpenBeforeAttach | The port has been opened by third-party serial application before your program calls Attach method. |
| OnPurge | Serial application purged all data in input and output queues. |
| OnQueryOpen | This event fires when third-party serial application tries to open virtual serial port. |
| OnRxChar | The data has been written to the port. |
| Port settings | |
| OnBaudRate | Baudrate communications parameter has been set. |
| OnDataBits | DataBits communications parameter has been set. |
| OnParity | Parity communications parameter has been set. |
| OnStopBits | StopBits communications parameter has been set. |
| OnTimeouts | Timeouts value has been set. |
| Signals | |
| OnDtr | DTR signal has been changed. |
| OnRts | RTS signal has been changed. |
| Flow control | |
| OnBreakChar | BREAK character has been set. |
| OnEofChar | EOF character has been set. |
| OnErrorChar | ERROR character has been set. |
| OnEvtChar | EVENT character has been set. |
| OnXoffChar | XOFF character has been set. |
| OnXoffLim | XOFFLIM value has been set. |
| OnXonChar | XON character has been set. |
| OnXonLim | XONLIM value has been set. |
| Extended flow control | |
| OnAbortOnError | Value of fAbortOnError member of DCB structure changed. |
| OnDsrSensitivity | Value of fDsrSensitivity member of DCB structure changed. |
| OnDtrControl | Value of fDtrControl member of DCB structure changed. |
| OnInX | Value of fInX member of DCB structure changed. |
| OnNull | Value of fNull member of DCB structure changed. |
| OnOutX | Value of fOutX member of DCB structure changed. |
| OnOutxCtsFlow | Value of fOutxCtsFlow member of DCB structure changed. |
| OnOutxDsrFlow | Value of fOutxDsrFlow member of DCB structure changed. |
| OnRtsControl | Value of fRtsControl member of DCB structure changed. |
| OnTXContinueOnXoff | Value of fTXContinueOnXoff member of DCB structure changed. |
| OnUseErrorChar | Value of fErrorChar member of DCB structure changed. |