 | wclSerialClientTransmitCommChar Method |
Transmits a specified character ahead of any pending data in the
output buffer of the specified communications device.
Namespace: wclSerialFrameworkAssembly: wclSerialFramework (in wclSerialFramework.dll) Version: 8.0.6.0
Syntaxpublic int TransmitCommChar(
byte Ch
)
Public Function TransmitCommChar (
Ch As Byte
) As Integer
public:
int TransmitCommChar(
unsigned char Ch
)
Parameters
- Ch Byte
-
The character to be transmitted. This must be an ASCII character.
Return Value
Int32
If the method completed with success the return value is
WCL_E_SUCCESS. Otherwise the method returns one of the
WCL error codes.
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, the TransmitCommChar
method cannot be called repeatedly. Once the TransmitCommChar
method places a character in the output buffer, the character must
be transmitted before the method can be called again. If the
previous character has not yet been sent, the
TransmitCommChar method returns an error.
See Also