StreamWait Method (WaitStatus)

public virtual StreamImage Wait(
	out WaitStatus status
)

Public Overridable Function Wait ( 
	<OutAttribute> ByRef status As WaitStatus
) As StreamImage

public:
virtual StreamImage^ Wait(
	[OutAttribute] WaitStatus% status
)

abstract Wait : 
        status : WaitStatus byref -> StreamImage 
override Wait : 
        status : WaitStatus byref -> StreamImage 

Parameters

status

Type: Stemmer.Cvb.DriverWaitStatus
Either Ok or Abort if opperation was Aborted.

Return Value

Implements

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.

You can also Abort this wait call which results in status being Abort.

Reference