close_io_deviceT_close_io_deviceCloseIoDeviceCloseIoDeviceclose_io_device (Operator)

Name

close_io_deviceT_close_io_deviceCloseIoDeviceCloseIoDeviceclose_io_device — Close the specified I/O device.

Signature

close_io_device( : : IODeviceHandle : )

Herror T_close_io_device(const Htuple IODeviceHandle)

void CloseIoDevice(const HTuple& IODeviceHandle)

void HIODevice::CloseIoDevice() const

static void HOperatorSet.CloseIoDevice(HTuple IODeviceHandle)

void HIODevice.CloseIoDevice()

def close_io_device(iodevice_handle: HHandle) -> None

Description

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

Execution Information

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

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle (input_control, state is modified)  io_device HIODevice, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the opened I/O device.

Result

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

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceOpenIoDeviceopen_io_device

Module

Foundation