IVsAsyncEnumCallback::OnDataAvailable Method (UInt32, Int32, UInt32, UInt32)

Visual Studio 2015

Event fired when data is available without blocking.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int OnDataAvailable(
	unsigned int cElementsAvailable,
	int fIsComplete,
	unsigned int ulProgressCurrent,
	unsigned int ulProgressMax
)

Parameters

cElementsAvailable: Type: System::UInt32
[in] Number of elements available to the consumer.

fIsComplete: Type: System::Int32
[in] A Boolean parameter indicating completion (true) of the event.

ulProgressCurrent: Type: System::UInt32
[in] Progress counter of elements served.

ulProgressMax: Type: System::UInt32
[in] Maximum number of elements available.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

The enumerator's behavior remains inherently synchronous, but as data is available without blocking OnDataAvailable() events are fired.

cElementsAvailable is always a delta. Pure progress information may be conveyed by the enumerator by passing 0 for cElementsAvailable and revised values for ulProgressCurrent and ulProgressMax.

COM Signature

From vsshell.idl:

C++

HRESULT IVsAsyncEnumCallback::OnDataAvailable(
   [in] ULONG cElementsAvailable, 
   [in] BOOL fIsComplete, 
   [in] ULONG ulProgressCurrent, 
   [in] ULONG ulProgressMax
);