 | wcl |
Inheritance HierarchyNamespace: wclSerialFramework
Assembly: wclSerialFramework (in wclSerialFramework.dll) Version: 8.0.6.0
SyntaxThe wclSerialTimeouts type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns the fully qualified type name of this instance. (Inherited from ValueType) |
Fields| Name | Description | |
|---|---|---|
 | ReadConstant | A 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 ReadMultiplier member and the requested number of bytes. A value of zero for both the ReadMultiplier and ReadConstant members indicates that total time-outs are not used for read operations. |
| ReadInterval | The maximum time allowed to elapse before the arrival of the next byte on the communications line, in milliseconds. If the interval between the arrival of any two bytes exceeds this amount, the Read operation is completed and any buffered data is returned. A value of zero indicates that interval time-outs are not used. A value of UInt32.Max, combined with zero values for both the ReadConstant and ReadMultiplier members, specifies that the read operation is to return immediately with the bytes that have already been received, even if no bytes have been received. |
| 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. |
| WriteConstant | A 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 WriteMultiplier member and the number of bytes to be written. A value of zero for both the WriteMultiplier and WriteConstant members indicates that total time-outs are not used for write operations. |
| 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. |
RemarksIf 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, Read waits until a byte arrives and then returns immediately.
If no bytes arrive within the time specified by ReadConstant, Read times out.
See Also