OnEvent Event

Posted on by Bogdan Bogowski

The OnEvent event is triggered everytime a communication event occurs.

OnEvent(
  	LONG EvtMask 	 
);

Parameters:

  • EvtMask [out] : The variable that receives a mask indicating the type of event that occurred. Can be one of the following values:
    Value Meaning Hex
    VSERIAL_EV_RXCHAR A character was received and placed in the input buffer.
    0x00000001
    VSERIAL_EV_RTS The RTS (request-to-send) signal changed state on the remote port.
    0x00000008
    VSERIAL_EV_DTR The DTR (request-to-send) signal changed state on the remote port.
    0x00000010
    VSERIAL_EV_RING A ring indicator was detected.
    0x00000100
    VSERIAL_EV_REMOTE_OPENCLOSE Remote port was opened or closed.
    0x80000000
    VSERIAL_EV_REMOTE_LINECONTROL Line control parameters were changed on the remote port.
    0x40000000
    VSERIAL_EV_REMOTE_TIMEOUTS Timeouts parameters were changed on the remote port. (Only Windows NT/2K/XP)
    0x40000000
    VSERIAL_EV_REMOTE_QUEUESIZE Queue size was changed on the remote port.
    0x20000000
    VSERIAL_EV_REMOTE_CHARS Special (event) characters were changed on the remote port.
    0x10000000
    VSERIAL_EV_REMOTE_HANDFLOW Flow control parameters were changed on the remote port.
    0x08000000
    VSERIAL_EV_REMOTE_BAUDRATE Baud rate was changed on the remote port.
    0x04000000
Tip: See also: OnBaudRate>, OnDTR , OnHandFlow, OnLineControl , OnOpenClose , OnRxChar, OnRTS , OnSpecialChars , OnTimeouts