close_io_deviceT_close_io_deviceCloseIoDeviceCloseIoDevice (Operator)

Name

close_io_deviceT_close_io_deviceCloseIoDeviceCloseIoDevice — Close the specified I/O device.

close_io_device( : : IODeviceHandle : )

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.

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.

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control, state is modified) io_device → (handle)

Handle of the opened I/O device.

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.

Foundation