Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

TransmitCommChar function

Transmits a specified character ahead of any pending data in the output buffer of the specified communications device.

Syntax


BOOL WINAPI TransmitCommChar(
  _In_ HANDLE hFile,
  _In_ char   cChar
);

Parameters

hFile [in]

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

cChar [in]

The character to be transmitted.

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

The TransmitCommChar function is useful for sending an interrupt character (such as a CTRL+C) to a host system.

If the device is not transmitting, TransmitCommChar cannot be called repeatedly. Once TransmitCommChar places a character in the output buffer, the character must be transmitted before the function can be called again. If the previous character has not yet been sent, TransmitCommChar returns an error.

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
CreateFile
WaitCommEvent

 

 

Community Additions

ADD
Show:
© 2015 Microsoft