HALCON Reference Manual 10.0.2

clear_serialclear_serialclear_serialClearSerialClearSerial (Operator)

Name

clear_serialclear_serialclear_serialClearSerialClearSerial — Clear the buffer of a serial connection.

Signature

clear_serial( : : SerialHandle, Channel : )

clear_serialclear_serialclear_serialClearSerialClearSerial 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").

Parallelization

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

Parameters

SerialHandleSerialHandleSerialHandleSerialHandleserialHandle (input_control) 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: 'input'"input""input""input""input", 'output'"output""output""output""output", 'in_out'"in_out""in_out""in_out""in_out"

Result

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