Edit

IVdsService::QueryUnallocatedDisks method (vds.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 an enumeration object containing a list of the unallocated disks managed by VDS.

Syntax

HRESULT QueryUnallocatedDisks(
  [out] IEnumVdsObject **ppEnum
);

Parameters

[out] ppEnum

The address of an IEnumVdsObject interface pointer that can be used to enumerate the disks as disk objects. For more information, see Working with Enumeration Objects. Callers must release the interface and each of the disk objects when they are no longer needed by calling the IUnknown::Release method.

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/value Description
S_OK
 The enumeration was returned successfully.
VDS_E_INITIALIZED_FAILED
0x80042401L
 VDS failed to initialize. If an application calls this method before the service finishes initializing, the method is blocked until the initialization completes. If the initialization fails, this error is returned.

Remarks

An unallocated disk is not claimed by any provider. It may or may not contain MBR or GPT partition format information. Often it is an uninitialized disk. If the disk status is VDS_DS_ONLINE or VDS_DS_OFFLINE, the disk is unallocated and uninitialized. If it is VDS_DS_UNKNOWN, VDS_DS_NOT_READY, VDS_DS_FAILED, or VDS_DS_MISSING, it is unallocated, but the VDS service cannot determine whether or not it is initialized, possibly because of problems with the disk.

To determine the disk status, see the status member of the VDS_DISK_PROP or VDS_DISK_PROP2 structure for the disk.

If the disk status is VDS_DS_ONLINE, the disk can be added to a pack.

If the disk status is VDS_DS_OFFLINE, try to bring the disk online by calling IVdsDiskOnline::Online. If the call to the Online method succeeds, the disk can be added to a pack. If the call to Online fails, the disk cannot be used.

Requirements

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

See also

IEnumVdsObject

IVdsService