clear_serialclear_serialClearSerialClearSerial (Operator)

Name

clear_serialclear_serialClearSerialClearSerial — Clear the buffer of a serial connection.

Signature

clear_serial( : : SerialHandle, Channel : )

clear_serialclear_serialClearSerialClearSerialClearSerial discards data written to the serial device referred to by SerialHandleSerialHandleSerialHandleSerialHandleserialHandle, but not transmitted (ChannelChannelChannelChannelchannel = 'output'"output""output""output""output"), or data received, but not read (ChannelChannelChannelChannelchannel = 'input'"input""input""input""input"), or performs both these operations at once (ChannelChannelChannelChannelchannel = 'in_out'"in_out""in_out""in_out""in_out").

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control, state is modified) serial_id → (integer)

Serial interface handle.

ChannelChannelChannelChannelchannel (input_control) string → (string)

Buffer to be cleared.

Default value: 'input' "input" "input" "input" "input"

List of values: 'in_out'"in_out""in_out""in_out""in_out", 'input'"input""input""input""input", 'output'"output""output""output""output"

Result

If the parameters are correct and the buffers of the serial device could be cleared, the operator clear_serialclear_serialClearSerialClearSerialClearSerial returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.