Click or drag to resize

IMcCaptDevice2BeginSnap Method

Start a single snap operation on the capture device.

Namespace:  MediaCy.IQL.Capture
Assembly:  MediaCy.IQL.Capture (in MediaCy.IQL.Capture.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function BeginSnap ( 
	Optional Flags As mcImageCreateFlags = mcImageCreateFlags.mcicfDefault,
	<OptionalAttribute> vImage As Object
) As mcCaptureErrorCodes

Parameters

Flags (Optional)
Type: MediaCy.IQL.EnginemcImageCreateFlags
Image creation flags if Snap is creating image
vImage (Optional)
Type: SystemObject

Return Value

Type: mcCaptureErrorCodes

Implements

IMcCaptDeviceBeginSnap(mcImageCreateFlags, Object)
Remarks
Calling this method starts a single frame asynchronous snap on the device. Call the EndSnap method to poll if the snap is complete or to cancel. Also, a SnapComplete event will be sent when the snap is finished that can be used as a completion trigger. Call EndSnap to retrieve the McImage that has the snap data if an image wasn't passed into this call. This method will fail if the capture device is closed or if the capture device is closed or a stream or snap operation is currently in progress.
See Also