clear_serialT_clear_serialClearSerialClearSerialclear_serial (Operator)

Name

clear_serialT_clear_serialClearSerialClearSerialclear_serial — Clear the buffer of a serial connection.

Signature

clear_serial( : : SerialHandle, Channel : )

Description

clear_serialclear_serialClearSerialClearSerialclear_serial discards data written to the serial device referred to by SerialHandleSerialHandleSerialHandleserialHandleserial_handle, 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:

SerialHandleSerialHandleSerialHandleserialHandleserial_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SerialHandleSerialHandleSerialHandleserialHandleserial_handle (input_control, state is modified) serial → (handle)

Serial interface handle.

ChannelChannelChannelchannelchannel (input_control) string → (string)

Buffer to be cleared.

Default: '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_serialClearSerialClearSerialclear_serial returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.