Operator Reference

close_serialT_close_serialCloseSerialCloseSerialclose_serial (Operator)

close_serialT_close_serialCloseSerialCloseSerialclose_serial — Close a serial device.

Signature

close_serial( : : SerialHandle : )

Herror T_close_serial(const Htuple SerialHandle)

void CloseSerial(const HTuple& SerialHandle)

void HSerial::CloseSerial() const

static void HOperatorSet.CloseSerial(HTuple serialHandle)

void HSerial.CloseSerial()

def close_serial(serial_handle: HHandle) -> None

Description

close_serialclose_serialCloseSerialCloseSerialclose_serial closes a serial device that was opened with open_serialopen_serialOpenSerialOpenSerialopen_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

SerialHandleSerialHandleSerialHandleserialHandleserial_handle (input_control, state is modified)  serial HSerial, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Serial interface handle.

Result

If the parameters are correct and the device could be closed, the operator close_serialclose_serialCloseSerialCloseSerialclose_serial returns the value 2 ( H_MSG_TRUE) . Otherwise an exception is raised.

Possible Predecessors

open_serialopen_serialOpenSerialOpenSerialopen_serial

See also

open_serialopen_serialOpenSerialOpenSerialopen_serial, close_fileclose_fileCloseFileCloseFileclose_file

Module

Foundation