SetCommBreak

SetCommBreak function

Suspends character transmission for a specified communications device and places the transmission line in a break state until the ClearCommBreak function is called.

Syntax


BOOL WINAPI SetCommBreak(
  _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.

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

ClearCommBreak
Communications Functions
Communications Resources
CreateFile

 

 

Community Additions

ADD
Show:
© 2016 Microsoft