Virtual Serial Port Control Help
Virtual Serial Port Control Help| Name | Value | Description |
|---|---|---|
| VspcOpenClose | 1 |
This event fires when an application opens or closes port. Value - non-zero value if port is opened, zero - otherwise. |
| VspcRxChar | 2 |
This event fires when a application writes data to virtual port. Value - number of bytes written. |
| VspcDTR | 3 |
This event fires when application chages DTR setting. Value - non-zero value if DTR is on, zero - otherwise. |
| VspcRTS | 4 |
This event fires when an application changes RTS setting. Value - non-zero value if RTS is on, zero - otherwise. |
| VspcBaudRate | 5 |
This event fires when an application changes BaudRate setting. Value - value of baud rate setting. |
| VspcfOutxCtsFlow | 6 |
This event fires when application changes fOutxCtsFlow setting. If value is nonzero, the CTS (clear-to-send) signal is monitored for output flow control. If value is nonzero and CTS is turned off, output is suspended until CTS is sent again. |
| VspcfOutxDsrFlow | 7 |
This event fires when application changes fOutxDsrFlow setting. If value is nonzero, the DSR (data-set-ready) signal is monitored for output flow control. If value is nonzero and DSR is turned off, output is suspended until DSR is sent again. |
| VspcfDtrControl | 8 |
This event fires when application changes fDtrControl setting. Value can be one of the following values: DTR_CONTROL_DISABLE - Disables the DTR line when the device is opened and leaves it disabled. DTR_CONTROL_ENABLE - Enables the DTR line when the device is opened and leaves it on. DTR_CONTROL_HANDSHAKE - Enables DTR handshaking. If handshaking is enabled, it is an error for the application to adjust the line by using the EscapeCommFunction function. |
| VspcfDsrSensitivity | 9 |
This event fires when application changes fDtrControl setting. If value is nonzero, the communications driver is sensitive to the state of the DSR signal. The driver ignores any bytes received, unless the DSR modem input line is high. |
| VspcfTXContinueOnXoff | 10 |
This event fires when application changes fTXContinueOnXoff setting. If value is nonzero, transmission continues after the input buffer has come within XoffLim bytes of being full and the driver has transmitted the XoffChar character to stop receiving bytes. If value is zero, transmission does not continue until the input buffer is within XonLim bytes of being empty and the driver has transmitted the XonChar character to resume reception. |
| VspcfOutX | 11 |
This event fires when application changes fOutX setting.
Indicates whether XON/XOFF flow control is used during transmission. If value is nonzero, transmission stops when the XoffChar character is received and starts again when the XonChar character is received. |
| VspcfInX | 12 |
This event fires when application changes fInX setting.
Indicates whether XON/XOFF flow control is used during reception. If value is nonzero, the XoffChar character is sent when the input buffer comes within XoffLim bytes of being full, and the XonChar character is sent when the input buffer comes within XonLim bytes of being empty. |
| VspcfNull | 13 |
This event fires when application changes fNull setting. If value is zero, null bytes are discarded when received. |
| VspcfRtsControl | 14 |
This event fires when application changes fRtsControl setting. Value can be one of the following values: RTS_CONTROL_DISABLE - Disables the RTS line when the device is opened and leaves it disabled. RTS_CONTROL_ENABLE - Enables the RTS line when the device is opened and leaves it on. RTS_CONTROL_HANDSHAKE - Enables RTS handshaking. The driver raises the RTS line when the "type-ahead" (input) buffer is less than one-half full and lowers the RTS line when the buffer is more than three-quarters full. If handshaking is enabled, it is an error for the application to adjust the line by using the EscapeCommFunction function. RTS_CONTROL_TOGGLE - Specifies that the RTS line will be high if bytes are available for transmission. After all buffered bytes have been sent, the RTS line will be low. |
| VspcfAbortOnError | 15 |
This event fires when application changes fAbortOnError setting. If value is nonzero, 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 the error by calling the ClearCommError function. |
| VspcXonLim | 16 |
This event fires when application changes XonLim setting. Minimum number of bytes allowed in the input buffer before flow control is activated to inhibit the sender. Note that the sender may transmit characters after the flow control signal has been activated, so this value should never be zero. This assumes that either XON/XOFF, RTS, or DTR input flow control is specified in fInX, fRtsControl, or fDtrControl. |
| VspcXoffLim | 17 |
This event fires when application changes XoffLim setting. Maximum number of bytes allowed in the input buffer before flow control is activated to allow transmission by the sender. This assumes that either XON/XOFF, RTS, or DTR input flow control is specified in fInX, fRtsControl, or fDtrControl. The maximum number of bytes allowed is calculated by subtracting this value from the size, in bytes, of the input buffer. |
| VspcByteSize | 18 |
This event fires when application changes ByteSize setting. Value - count of bits in byte. |
| VspcParity | 19 |
This event fires when application changes Parity setting. Value - parity control: 0 - NO PARITY 1 - ODD PARITY 2 - EVEN PARITY 3 - MARK PARITY 4 - SPACE PARITY |
| VspcStopBits | 20 |
This event fires when application changes StopBits setting. Value - count of stop bits: 0 - ONE STOPBIT 1 - 1.5 STOPBITS 2 - TWO STOPBITS |
| VspcXonChar | 21 |
This event fires when application changes XonChar setting. Value - xon char. |
| VspcXoffChar | 22 |
This event fires when application changes XoffChar setting. Value - xoff char. |
| VspcErrorChar | 23 |
This event fires when application changes ErrorChar setting. Value - error char. |
| VspcEofChar | 24 |
This event fires when application changes EofChar setting. Value - eof char. |
| VspcEvtChar | 25 |
This event fires when application changes EvtChar setting. Value - event char. |
| VspcBreakChar | 26 |
This event fires when application changes BreakChar setting. Value - break char. |
| VspcBreak | 27 |
This event fires when application calls SetCommBreak or ClearCommBreak. Value - zero, if ClearCommBreak is called. |
| VspcPurge | 28 |
This event fires when application calls PurgeComm. Value can be one or more of the following values: PURGE_TXABORT - Terminates all outstanding overlapped write operations and returns immediately, even if the write operations have not been completed. PURGE_RXABORT - Terminates all outstanding overlapped read operations and returns immediately, even if the read operations have not been completed. PURGE_TXCLEAR - Clears the output buffer (if the device driver has one). PURGE_RXCLEAR - Clears the input buffer (if the device driver has one). |