ClearCommBreak (Compact 2013)

3/28/2014

This function restores character transmission for a specified communications device and places the transmission line in a nonbreak state.

Syntax

BOOL ClearCommBreak(
  HANDLE hFile
);

Parameters

  • hFile
    [in] Handle to the communications device, returned by the CreateFile function.

Return Value

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

Remarks

A communications device is placed in a break state by the SetCommBreak or EscapeCommFunction function.

Character transmission is suspended until the break state is cleared by calling the ClearCommError function.

Requirements

Header

winbase.h

Library

Serdev.lib

See Also

Reference

Serial Communications Functions
ClearCommError
EscapeCommFunction
SetCommBreak

Other Resources

CreateFile