Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

GetCommTimeouts function

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

Syntax


BOOL WINAPI GetCommTimeouts(
  _In_   HANDLE hFile,
  _Out_  LPCOMMTIMEOUTS lpCommTimeouts
);

Parameters

hFile [in]

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

lpCommTimeouts [out]

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

Return value

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.

Remarks

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

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Communications Functions
Communications Resources
CreateFile
COMMTIMEOUTS
SetCommTimeouts

 

 

Community Additions

Show:
© 2014 Microsoft