Operator Reference

HALCON Operator Reference / System / I/O Devices

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

close_io_deviceT_close_io_deviceCloseIoDeviceCloseIoDeviceclose_io_device (Operator)

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_deviceCloseIoDeviceCloseIoDeviceclose_io_device closes the I/O device specified by IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle. In particular, all associated channels are closed (i.e., close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_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

• 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:

• IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_handle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

IODeviceHandleIODeviceHandleIODeviceHandleIODeviceHandleiodevice_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_deviceCloseIoDeviceCloseIoDeviceclose_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_infoGetExtendedErrorInfoGetExtendedErrorInfoget_extended_error_info.

Possible Predecessors

open_io_deviceopen_io_deviceOpenIoDeviceOpenIoDeviceopen_io_device

Module

Foundation

---

ClassesClasses | | Operators