ClearCommBreak function

Restores character transmission for a specified communications device and places the transmission line in a nonbreak state.

Syntax


BOOL WINAPI ClearCommBreak(
  _In_ HANDLE hFile
);

Parameters

hFile [in]

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

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

A communications device is placed in a break state by the SetCommBreak or EscapeCommFunction function. Character transmission is then suspended until the break state is cleared by calling ClearCommBreak.

Requirements

Minimum supported client

Windows XP [desktop apps | UWP apps]

Minimum supported server

Windows Server 2003 [desktop apps | UWP apps]

Header

Winbase.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

ClearCommError
Communications Functions
Communications Resources
CreateFile
EscapeCommFunction
SetCommBreak

 

 

Show: