disconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_sourceT_disconnect_image_source
Short description
disconnect_image_sourceDisconnectImageSourceDisconnectImageSourcedisconnect_image_sourceT_disconnect_image_source — Disconnect an image source.
Signature
disconnect_image_source( image_source ImageSourceHandle, attribute.name GenParamName, attribute.value GenParamValue )void DisconnectImageSource( const HTuple& ImageSourceHandle, const HTuple& GenParamName, const HTuple& GenParamValue )static void HOperatorSet.DisconnectImageSource( HTuple imageSourceHandle, HTuple genParamName, HTuple genParamValue )def disconnect_image_source( image_source_handle: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[int, float, str]] ) -> None
Herror T_disconnect_image_source( const Htuple ImageSourceHandle, const Htuple GenParamName, const Htuple GenParamValue )
void HImageSource::DisconnectImageSource( const HTuple& GenParamName, const HTuple& GenParamValue ) const
void HImageSource.DisconnectImageSource( HTuple genParamName, HTuple genParamValue )
Description
disconnect_image_sourceDisconnectImageSource closes the connection to the image source
module specified in ImageSourceHandleimageSourceHandleimage_source_handle.
After the call, the handle ImageSourceHandleimageSourceHandleimage_source_handle is in an unconnected
state.
For further information about the states of an image source see
Image Source.
Currently, no generic parameters GenParamNamegenParamNamegen_param_name and
GenParamValuegenParamValuegen_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
ImageSourceHandleimageSourceHandleimage_source_handle (input_control) image_source → (handle)HTuple (HHandle)HImageSource, HTuple (IntPtr)HHandleHtuple (handle)
Image source handle to be disconnected.
GenParamNamegenParamNamegen_param_name (input_control) attribute.name-array → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)
Generic parameter name.
Default: [][]
GenParamValuegenParamValuegen_param_value (input_control) attribute.value-array → (integer / real / string)HTuple (Hlong / double / HString)HTuple (int / long / double / string)Sequence[Union[int, float, str]]Htuple (Hlong / double / char*)
Generic parameter value.
Default: [][]
Result
If the parameter values are correct and the desired image source
could be disconnected, disconnect_image_sourceDisconnectImageSource returns the value
2 (H_MSG_TRUE). Otherwise an exception is raised.
Combinations with other operators
Combinations
Possible predecessors
stop_image_sourceStopImageSource, connect_image_sourceConnectImageSource
See also
connect_image_sourceConnectImageSource
Module
Foundation