IAcquisitionGetTimedSnapshot Method (UsTimeSpan, WaitStatus)

StreamImage GetTimedSnapshot(
	UsTimeSpan timeSpan,
	out WaitStatus status
)

Function GetTimedSnapshot ( 
	timeSpan As UsTimeSpan,
	<OutAttribute> ByRef status As WaitStatus
) As StreamImage

StreamImage^ GetTimedSnapshot(
	UsTimeSpan timeSpan, 
	[OutAttribute] WaitStatus% status
)

abstract GetTimedSnapshot : 
        timeSpan : UsTimeSpan * 
        status : WaitStatus byref -> StreamImage 

Parameters

timeSpan

Type: Stemmer.Cvb.UtilitiesUsTimeSpan
Time span to wait for (millisecond granularity).

status

Type: Stemmer.Cvb.DriverWaitStatus
Variable to receive the status of this operation.

Return Value

Waits for the given timeSpan for the image to be taken.

Attention: it is generally not possible to call this method while the acquisition has been started by Start.

Dispose the returned Image when not needed anymore!

By default the returned image content is only guaranteed to stay unchanged until the next call to this method; afterwards the returned image is normally disposed. Thus it is normally not save to use this image in a display.

This method does not throw an exception when timeSpan is exceeded; it will report this in the status with Timeout. Other exceptions still might get thrown on error conditions.

Reference