Operator Reference
close_serial (Operator)
close_serial
— Close a serial device.
Signature
close_serial( : : SerialHandle : )
Description
close_serial
closes a serial device that was opened with
open_serial
.
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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
SerialHandle
(input_control, state is modified) serial →
(handle)
Serial interface handle.
Result
If the parameters are correct and the device could be closed, the
operator close_serial
returns the value 2 (
H_MSG_TRUE)
. Otherwise an
exception is raised.
Possible Predecessors
See also
Module
Foundation