SetCommTimeouts function

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

Syntax


BOOL WINAPI SetCommTimeouts(
  _In_  HANDLE hFile,
  _In_  LPCOMMTIMEOUTS lpCommTimeouts
);

Parameters

hFile [in]

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

lpCommTimeouts [in]

A pointer to a COMMTIMEOUTS structure that contains the new time-out values.

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.

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
COMMTIMEOUTS
GetCommTimeouts
ReadFile
ReadFileEx
WriteFile
WriteFileEx

 

 

Community Additions

ADD
Show:
© 2014 Microsoft