OnTimeouts Event

Description

The OnTimeouts event is triggered automatically everytime an application changes ports timeouts.

Syntax

Visual Basic

Private Sub FTVirtualSerialControlObject_OnTimeouts(
    ByVal ReadIntervalTimeout As Long,
    ByVal ReadTotalTimeoutMultiplier As Long,
    ByVal ReadTotalTimeoutConstant As Long,
    ByVal WriteTotalTimeoutMultiplier As Long,
    ByVal WriteTotalTimeoutConstant As Long
)

Visual C++

void CSiteWindowName::OnTimeoutsFTVirtualSerialControl(
    LONG ReadIntervalTimeout,
    LONG ReadTotalTimeoutMultiplier,
    LONG ReadTotalTimeoutConstant,
    LONG WriteTotalTimeoutMultiplier,
    LONG WriteTotalTimeoutConstant
);

Delphi

procedure FTVirtualSerialControlObjectOnTimeouts(
    ASender: TObject;
    ReadIntervalTimeout: Long;
    ReadTotalTimeoutMultiplier: Long;
    ReadTotalTimeoutConstant: Long;
    WriteTotalTimeoutMultiplier: Long;
    WriteTotalTimeoutConstant: Long
)

Remarks

Parameter Description
ReadIntervalTimeout Maximum time allowed to elapse between the arrival of two characters on the communications line, in milliseconds. During a ReadFile operation the time period begins when the first character is received. If the interval between the arrival of any two characters exceeds this amount, the ReadFile operation is completed and any buffered data is returned. A value of zero indicates that interval time-outs are not used.
A value of MAXDWORD, combined with zero values for both the ReadTotalTimeoutConstant and ReadTotalTimeoutMultiplier members, specifies that the read operation is to return immediately with the characters that have already been received, even if no characters have been received.
ReadTotalTimeoutMultiplier Multiplier used to calculate the total time-out period for read operations, in milliseconds. For each read operation, this value is multiplied by the requested number of bytes to be read.
ReadTotalTimeoutConstant Constant used to calculate the total time-out period for read operations, in milliseconds. For each read operation, this value is added to the product of the ReadTotalTimeoutMultiplier member and the requested number of bytes.
A value of zero for both the ReadTotalTimeoutMultiplier and ReadTotalTimeoutConstant members indicates that total time-outs are not used for read operations.
WriteTotalTimeoutMultiplier Multiplier used to calculate the total time-out period for write operations, in milliseconds. For each write operation, this value is multiplied by the number of bytes to be written.
WriteTotalTimeoutConstant Constant used to calculate the total time-out period for write operations, in milliseconds. For each write operation, this value is added to the product of the WriteTotalTimeoutMultiplier member and the number of bytes to be written.
A value of zero for both the WriteTotalTimeoutMultiplier and WriteTotalTimeoutConstant members indicates that total time-outs are not used for write operations.