disconnect_image_sourceT_disconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source (Operator)
Name
disconnect_image_sourceT_disconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source — Disconnect an image source.
Signature
Description
disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source closes the connection to the image source
module specified in ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle.
After the call, the handle ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle is in an unconnected
state.
For further information about the states of an image source see
Image Source.
Currently, no generic parameters GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value are supported.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ImageSourceHandleImageSourceHandleImageSourceHandleimageSourceHandleimage_source_handle (input_control) image_source → HImageSource, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Image source handle to be disconnected.
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Generic parameter name.
Default:
[]
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)
Generic parameter value.
Default:
[]
Result
If the parameter values are correct and the desired image source
could be disconnected, disconnect_image_sourcedisconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_source returns the value
2 (
H_MSG_TRUE)
. Otherwise an exception is raised.
Possible Predecessors
stop_image_sourcestop_image_sourceStopImageSourceStopImageSourcestop_image_source,
connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source
See also
connect_image_sourceconnect_image_sourceConnectImageSourceConnectImageSourceconnect_image_source
Module
Foundation