wclSerialTimeouts Struct Reference

Contains the time-out parameters for a communications device. More...

#include <wclSerialClients.h>

Public Attributes
unsigned long	ReadInterval
unsigned long	ReadMultiplier
	The 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.
unsigned long	ReadConstant
unsigned long	WriteMultiplier
	The 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.
unsigned long	WriteConstant

Detailed Description

Contains the time-out parameters for a communications device.

If an application sets ReadInterval and ReadMultiplier to MAXDWORD and sets ReadConstant to a value greater than zero and less than MAXDWORD, one of the following occurs when the ReadFile function is called:

If there are any bytes in the input buffer, ReadFile returns immediately with the bytes in the buffer.

If there are no bytes in the input buffer, ReadFile waits until a byte arrives and then returns immediately.

If no bytes arrive within the time specified by ReadConstant, ReadFile times out.