Prev Next

GetCommTimeouts info  Overview  Group

The GetCommTimeouts function retrieves the time-out parameters for all read and write operations on a specified communications device.

BOOL GetCommTimeouts(

    HANDLE hFile,

// handle of communications device

    LPCOMMTIMEOUTS lpCommTimeouts

// address of comm. time-outs structure

   );

Parameters

hFile
Identifies the communications device. The CreateFile function returns this handle.
lpCommTimeouts
Points to a COMMTIMEOUTS structure in which the time-out information is returned.

Return Values

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.

See Also

CreateFile, COMMTIMEOUTS, SetCommTimeouts