IEnumVdsObject::Next method (vdshwprv.h)

  • Article

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Returns a specified number of objects in the enumeration, beginning from the current point. For more information, see Working with Enumeration Objects.

Syntax

HRESULT Next(
  [in]  ULONG    celt,
  [out] IUnknown **ppObjectArray,
  [out] ULONG    *pcFetched
);

Parameters

[in] celt

The number of objects to return.

[out] ppObjectArray

The address of an array of IUnknown pointers, which VDS initializes on return.

[out] pcFetched

The address of a ULONG, which VDS initializes on return to the number of objects in ppObjectArray.

Return value

This method can return standard HRESULT values, such as E_INVALIDARG or E_OUTOFMEMORY, and VDS-specific return values. It can also return converted system error codes using the HRESULT_FROM_WIN32 macro. Errors can originate from VDS itself or from the underlying VDS provider that is being used. Possible return values include the following.

Return code Description
S_OK
 The method returned the specified number of objects. The number of returned objects reported in pcFetched equals celt; returns those objects.
S_FALSE
 The specified number of returned objects is greater than the number of objects remaining. All remaining objects are returned, and the number of returned objects is reported in pcFetched is less than celt; returns those objects.

Remarks

To obtain object-specific interface pointers from the IUnknown pointers returned in the ppObjectArray array, use the IUnknown::QueryInterface method.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vdshwprv.h
Library Uuid.lib

See also

IEnumVdsObject