IAcquisitionWaitFor Method (UsTimeSpan, WaitStatus)

StreamImage WaitFor(
	UsTimeSpan timeSpan,
	out WaitStatus status
)

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

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

abstract WaitFor : 
        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

Attention: it is generally not safe to call the wait method from different threads on the same object!

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.

The returned image is not necessary the newest. If more images where acquired since the last call to this method, the content is the oldest not collected image buffer by default.

This method does not throw an exception when the operation was Aborted or did time out; it will report this in the status with Abort and Timeout respectively. Other exceptions still might get thrown on error conditions.

Reference