KsGetCommTimeouts

The availability of this function depends on what the device supports.

Retrieves the time-out parameters for all read and write operations on a specified communications device.

Syntax

BOOL KsGetCommTimeouts(
     HANDLE hFile,
     LPCOMMTIMEOUTS lpCommTimeouts
);

Parameters

hFile: a handle to the communications device. The KsCreateComm function returns this handle.

lpCommTimeouts: a pointer to a COMMTIMEOUTS structure in which the time-out information is returned.

Return value

If the function succeeds, it returns TRUE, otherwise FALSE. To get extended error information, call GetLastError.

Remarks

For more information about time-out values for communications devices, see the KsSetCommTimeouts function.

Example

N/A

Requirements