Skip to content

close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_io_channelT_close_io_channel🔗

Short description🔗

close_io_channelclose_io_channelCloseIoChannelCloseIoChannelclose_io_channelT_close_io_channel — Close I/O channels.

Signature🔗

close_io_channel( io_channel IOChannelHandle )close_io_channel( : : IOChannelHandle : )void CloseIoChannel( const HTuple& IOChannelHandle )static void HOperatorSet.CloseIoChannel( HTuple IOChannelHandle )def close_io_channel( iochannel_handle: MaybeSequence[HHandle] ) -> None

Herror T_close_io_channel( const Htuple IOChannelHandle )

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

void HIOChannel::CloseIoChannel( ) const

static void HIOChannel.CloseIoChannel( HIOChannel[] IOChannelHandle )

void HIOChannel.CloseIoChannel( )

Description🔗

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

Execution information🔗

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:

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

Parameters🔗

IOChannelHandleIOChannelHandleiochannel_handle (input_control, state is modified) io_channel(-array) → (handle)(handle)HTuple (HHandle)HIOChannel, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handles of the opened I/O channels.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

open_io_channelOpenIoChannel

Possible successors

close_io_deviceCloseIoDevice

Module🔗

Foundation