KsClearCommBreak

The availability of this function depends on what the device supports.

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

Syntax

BOOL KsClearCommBreak(
     HANDLE hFile
);

Parameters

hFile: a handle to the communications device. The KsCreateComm function returns this handle.

Return value

If the function succeeds, it returns TRUE, otherwise FALSE. To get extended error information, call GetLastError.

Remarks

A communications device is placed in a break state by the KsSetCommBreak or KsEscapeCommFunction function. Character transmission is then suspended until the break state is cleared by calling KsClearCommBreak.

Example

N/A

Requirements

  RT Win32
Minimum supported version 4.0 4.0
Header kscom.h kscom.h
Library KsApi_Rtss.lib ksapi.h

See also

KsClearCommError

KsCreateComm

KsSetCommBreak

KsEscapeCommFunction