ClassesClassesClassesClasses | | | | Operators

close_io_deviceclose_io_deviceCloseIoDeviceclose_io_deviceCloseIoDeviceCloseIoDevice (Operator)

Name

close_io_deviceclose_io_deviceCloseIoDeviceclose_io_deviceCloseIoDeviceCloseIoDevice — Close the specified I/O device.

Signature

close_io_device( : : IODeviceHandle : )

Herror close_io_device(const Hlong IODeviceHandle)

Herror T_close_io_device(const Htuple IODeviceHandle)

Herror close_io_device(const HTuple& IODeviceHandle)

void CloseIoDevice(const HTuple& IODeviceHandle)

void HOperatorSetX.CloseIoDevice([in] VARIANT IODeviceHandle)

static void HOperatorSet.CloseIoDevice(HTuple IODeviceHandle)

Description

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

Parallelization

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandle (input_control)  io_device HIODevice, HTupleHTupleHIODevice, HTupleHIODeviceX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handle of the opened I/O device.

Result

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

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceopen_io_deviceOpenIoDeviceOpenIoDevice

Module

Foundation


ClassesClassesClassesClasses | | | | Operators