GetCommTimeouts

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

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

BOOL
GetCommTimeouts(
HANDLE
hFile
,
LPCOMMTIMEOUTS
lpCommTimeouts
);

Parameters

hFile

[in] Handle to the communication device. The CreateFilefunction returns this handle.

lpCommTimeouts

[out] Long pointer to a COMMTIMEOUTSstructure in which the time-out data is returned.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error data, call GetLastError.

Remarks

For more information about time-out values for communication devices, see the SetCommTimeoutsfunction.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	1.0 and later	Winbase.h		Serdev.lib

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.