Operator Reference

HALCON Operator Reference / System / I/O Devices

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

ClassesClasses | | Operators

close_io_channelT_close_io_channelCloseIoChannelCloseIoChannelclose_io_channel (Operator)

close_io_channelT_close_io_channelCloseIoChannelCloseIoChannelclose_io_channel — Close I/O channels.

Signature

close_io_channel( : : IOChannelHandle : )

Herror T_close_io_channel(const Htuple IOChannelHandle)

void CloseIoChannel(const HTuple& IOChannelHandle)

static void HIOChannel::CloseIoChannel(const HIOChannelArray& IOChannelHandle)

void HIOChannel::CloseIoChannel() const

static void HOperatorSet.CloseIoChannel(HTuple IOChannelHandle)

static void HIOChannel.CloseIoChannel(HIOChannel[] IOChannelHandle)

void HIOChannel.CloseIoChannel()

def close_io_channel(iochannel_handle: MaybeSequence[HHandle]) -> None

Description

The operator close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_io_channel closes transmission channels opened by open_io_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel. The references to the channels are passed in IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle. In particular, allocated memory and reserved device resources are 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:

• IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle

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

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleiochannel_handle (input_control, state is modified)  io_channel(-array) → HIOChannel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handles of the opened I/O channels.

Result

If the parameters are valid, the operator close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_io_channel 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_channelopen_io_channelOpenIoChannelOpenIoChannelopen_io_channel

Possible Successors

close_io_deviceclose_io_deviceCloseIoDeviceCloseIoDeviceclose_io_device

Module

Foundation

---

ClassesClasses | | Operators