GetCommTimeouts function (winbase.h)

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

Syntax

C++

BOOL GetCommTimeouts(
  [in]  HANDLE         hFile,
  [out] LPCOMMTIMEOUTS lpCommTimeouts
);

[in] hFile

A handle to the communications device. The CreateFile function returns this handle.

[out] lpCommTimeouts

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

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

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

Requirement	Value
Minimum supported client	Windows XP [desktop apps \| UWP apps]
Minimum supported server	Windows Server 2003 [desktop apps \| UWP apps]
Target Platform	Windows
Header	winbase.h (include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll