Skip to content

close_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabberT_close_framegrabber🔗

Short description🔗

close_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabberT_close_framegrabber — Close specified image acquisition device.

Signature🔗

close_framegrabber( framegrabber AcqHandle )void CloseFramegrabber( const HTuple& AcqHandle )static void HOperatorSet.CloseFramegrabber( HTuple acqHandle )def close_framegrabber( acq_handle: HHandle ) -> None

Herror T_close_framegrabber( const Htuple AcqHandle )

void HFramegrabber::CloseFramegrabber( ) const

void HFramegrabber.CloseFramegrabber( )

Description🔗

The operator close_framegrabberCloseFramegrabber closes the image acquisition device specified by AcqHandleacqHandleacq_handle. In particular, allocated memory for data buffers is released and the image acquisition device is made available for other processes.

Attention🔗

For a multithreaded application, info_framegrabberInfoFramegrabber, open_framegrabberOpenFramegrabber, and close_framegrabberCloseFramegrabber are executed exclusively. Thus, they block the concurrent execution of each other, but run in parallel with all non-exclusive operators outside of this group.

Make sure that close_framegrabberCloseFramegrabber is not called for a framegrabber handle that is being used by another thread concurrently.

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🔗

AcqHandleacqHandleacq_handle (input_control, state is modified) framegrabber → (handle)HTuple (HHandle)HFramegrabber, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the image acquisition device to be closed.

Result🔗

If the specified image acquisition device could be closed, close_framegrabberCloseFramegrabber returns the value 2 (H_MSG_TRUE). Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

grab_imageGrabImage, grab_image_asyncGrabImageAsync

See also

open_framegrabberOpenFramegrabber

Module🔗

Foundation