close_framegrabberT_close_framegrabberCloseFramegrabberCloseFramegrabber (Operator)

Name

close_framegrabberT_close_framegrabberCloseFramegrabberCloseFramegrabber — Close specified image acquisition device.

Signature

close_framegrabber( : : AcqHandle : )

Description

The operator close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber closes the image acquisition device specified by AcqHandleAcqHandleAcqHandleAcqHandleacqHandle. 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 all image acquisition operators (as listed in open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber) are an own group in which info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers are executed exclusively.

Thus, info_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberInfoFramegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberOpenFramegrabber, close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberCloseFramegrabber and close_all_framegrabbersclose_all_framegrabbersCloseAllFramegrabbersCloseAllFramegrabbersCloseAllFramegrabbers block the concurrent execution of all other operators within this group, but run in parallel with all non-exclusive operators outside of this group.

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:

AcqHandleAcqHandleAcqHandleAcqHandleacqHandle

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

Parameters

AcqHandleAcqHandleAcqHandleAcqHandleacqHandle (input_control, state is modified) framegrabber → (handle)

Handle of the image acquisition device to be closed.

Result

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

Possible Predecessors

grab_imagegrab_imageGrabImageGrabImageGrabImage, grab_image_asyncgrab_image_asyncGrabImageAsyncGrabImageAsyncGrabImageAsync

Module

Foundation

Operators