ClassesClassesClassesClasses | | | | Operators

close_io_channelclose_io_channelCloseIoChannelclose_io_channelCloseIoChannelCloseIoChannel (Operator)

Name

close_io_channelclose_io_channelCloseIoChannelclose_io_channelCloseIoChannelCloseIoChannel — Close I/O channels.

Signature

close_io_channel( : : IOChannelHandle : )

Herror close_io_channel(const Hlong IOChannelHandle)

Herror T_close_io_channel(const Htuple IOChannelHandle)

Herror close_io_channel(const HTuple& IOChannelHandle)

void CloseIoChannel(const HTuple& IOChannelHandle)

void HOperatorSetX.CloseIoChannel([in] VARIANT IOChannelHandle)

static void HOperatorSet.CloseIoChannel(HTuple IOChannelHandle)

Description

The operator close_io_channelclose_io_channelCloseIoChannelclose_io_channelCloseIoChannelCloseIoChannel closes transmission channels opened by open_io_channelopen_io_channelOpenIoChannelopen_io_channelOpenIoChannelOpenIoChannel. The references to the channels are passed in IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle. In particular, allocated memory and reserved device resources are released.

Parallelization

Parameters

IOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandleIOChannelHandle (input_control)  io_channel(-array) HIOChannel, HTupleHTupleHIOChannel, HTupleHIOChannelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Handles of the opened I/O channels.

Result

If the parameters are valid, the operator close_io_channelclose_io_channelCloseIoChannelclose_io_channelCloseIoChannelCloseIoChannel 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_channelopen_io_channelOpenIoChannelopen_io_channelOpenIoChannelOpenIoChannel

Possible Successors

close_io_deviceclose_io_deviceCloseIoDeviceclose_io_deviceCloseIoDeviceCloseIoDevice

Module

Foundation


ClassesClassesClassesClasses | | | | Operators