Skip to content

close_io_deviceCloseIoDeviceCloseIoDeviceclose_io_deviceT_close_io_device🔗

Short description🔗

close_io_deviceCloseIoDeviceCloseIoDeviceclose_io_deviceT_close_io_device — Close the specified I/O device.

Signature🔗

close_io_device( io_device IODeviceHandle )void CloseIoDevice( const HTuple& IODeviceHandle )static void HOperatorSet.CloseIoDevice( HTuple IODeviceHandle )def close_io_device( iodevice_handle: HHandle ) -> None

Herror T_close_io_device( const Htuple IODeviceHandle )

void HIODevice::CloseIoDevice( ) const

void HIODevice.CloseIoDevice( )

Description🔗

The operator close_io_deviceCloseIoDevice closes the I/O device specified by IODeviceHandleIODeviceHandleiodevice_handle. In particular, all associated channels are closed (i.e., close_io_channelCloseIoChannel is called implicitly on all channels that had been opened for this device) and allocated memory for data buffers is released.

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🔗

IODeviceHandleIODeviceHandleiodevice_handle (input_control, state is modified) io_device → (handle)HTuple (HHandle)HIODevice, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the opened I/O device.

Result🔗

If the parameters are valid, the operator close_io_deviceCloseIoDevice returns the value 2 (H_MSG_TRUE). If necessary an exception is raised. In this case, an extended error information may be set and can be queried with the operator get_extended_error_infoGetExtendedErrorInfo.

Combinations with other operators🔗

Combinations

Possible predecessors

open_io_deviceOpenIoDevice

Module🔗

Foundation