Skip to content

close_serialCloseSerialCloseSerialclose_serialT_close_serial🔗

Short description🔗

close_serialCloseSerialCloseSerialclose_serialT_close_serial — Close a serial device.

Signature🔗

close_serial( serial SerialHandle )void CloseSerial( const HTuple& SerialHandle )static void HOperatorSet.CloseSerial( HTuple serialHandle )def close_serial( serial_handle: HHandle ) -> None

Herror T_close_serial( const Htuple SerialHandle )

void HSerial::CloseSerial( ) const

void HSerial.CloseSerial( )

Description🔗

close_serialCloseSerial closes a serial device that was opened with open_serialOpenSerial.

Execution information🔗

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🔗

SerialHandleserialHandleserial_handle (input_control, state is modified) serial → (handle)HTuple (HHandle)HSerial, HTuple (IntPtr)HHandleHtuple (handle)

Serial interface handle.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_serialOpenSerial

See also

open_serialOpenSerial, close_fileCloseFile

Module🔗

Foundation