GetCommTimeouts

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function retrieves the time-out parameters for all read and write operations on a specified communication device.

Syntax

BOOL GetCommTimeouts(
  HANDLE hFile,
  LPCOMMTIMEOUTS lpCommTimeouts
);

Parameters

  • hFile
    [in] Handle to the communication device returned by the CreateFile function.
  • lpCommTimeouts
    [out] Long pointer to a COMMTIMEOUTS structure in which the time-out data is returned.

Return Value

Nonzero indicates success. Zero indicates failure. To obtain extended error data, call the GetLastError function.

Remarks

For more information about timeout values for communication devices, see the SetCommTimeouts function.

Requirements

Header winbase.h
Library Serdev.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

Serial Communications Functions
COMMTIMEOUTS
SetCommTimeouts

Other Resources

CreateFile