close_io_deviceclose_io_deviceCloseIoDeviceCloseIoDevice (Operator)

Name

close_io_deviceclose_io_deviceCloseIoDeviceCloseIoDevice — Close the specified I/O device.

Signature

close_io_device( : : IODeviceHandle : )

Description

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

Execution Information

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

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control) io_device → (integer)

Handle of the opened I/O device.

Result

If the parameters are valid, the operator close_io_deviceclose_io_deviceCloseIoDeviceCloseIoDeviceCloseIoDevice 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_infoget_extended_error_infoGetExtendedErrorInfoGetExtendedErrorInfoGetExtendedErrorInfo.

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDevice

Module

Foundation