Operator Reference

close_framegrabberT_close_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber (Operator)

close_framegrabberT_close_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber — Close specified image acquisition device.

Signature

close_framegrabber( : : AcqHandle : )

Herror T_close_framegrabber(const Htuple AcqHandle)

void CloseFramegrabber(const HTuple& AcqHandle)

void HFramegrabber::CloseFramegrabber() const

static void HOperatorSet.CloseFramegrabber(HTuple acqHandle)

void HFramegrabber.CloseFramegrabber()

def close_framegrabber(acq_handle: HHandle) -> None

Description

The operator close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber closes the image acquisition device specified by AcqHandleAcqHandleAcqHandleacqHandleacq_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_framegrabberinfo_framegrabberInfoFramegrabberInfoFramegrabberinfo_framegrabber, open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber, and close_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber 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_framegrabberclose_framegrabberCloseFramegrabberCloseFramegrabberclose_framegrabber is not called for a framegrabber handle that is being used by another thread concurrently.

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

AcqHandleAcqHandleAcqHandleacqHandleacq_handle (input_control, state is modified)  framegrabber HFramegrabber, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the image acquisition device to be closed.

Result

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

Possible Predecessors

grab_imagegrab_imageGrabImageGrabImagegrab_image, grab_image_asyncgrab_image_asyncGrabImageAsyncGrabImageAsyncgrab_image_async

See also

open_framegrabberopen_framegrabberOpenFramegrabberOpenFramegrabberopen_framegrabber

Module

Foundation