SerCxGetReadIntervalTimeout method

The SerCxGetReadIntervalTimeout method returns the interval time-out value for a read (receive) operation.

Syntax


ULONG SerCxGetReadIntervalTimeout(
  [in] WDFDEVICE Device
);

Parameters

Device [in]

A WDFDEVICE handle to the framework device object that represents the serial controller.

Return value

SerCxGetReadIntervalTimeout returns the read-interval time-out value in milliseconds. A value of zero indicates that read-interval time-outs are not used.

Remarks

The read-interval time-out value is the maximum amount of time, in milliseconds, that is allowed between two consecutive bytes in a read operation. A read operation that exceeds this maximum times out. For more information about time-out values, see SERIAL_TIMEOUTS.

A read (IRP_MJ_READ) request successfully completes when the requested read operation times out. The request returns the STATUS_TIMEOUT status code to indicate that the operation timed out.

Requirements

Target platform

Universal

Version

Available starting with Windows 8.

Header

1.0\Sercx.h

IRQL

<= DISPATCH_LEVEL

See also

IRP_MJ_READ
SERIAL_TIMEOUTS

 

 

Send comments about this topic to Microsoft

Show: