Skip to content

Latest commit

 

History

History
108 lines (85 loc) · 5.9 KB

nf-vds-ivdshwproviderstoragepools-querystoragepools.md

File metadata and controls

108 lines (85 loc) · 5.9 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vds.IVdsHwProviderStoragePools.QueryStoragePools
IVdsHwProviderStoragePools::QueryStoragePools (vds.h)
The QueryStoragePools method (vds.h) returns an IEnumVdsObject enumeration object containing a list of the storage pools managed by the hardware provider.
IVdsHwProviderStoragePools interface
QueryStoragePools method
IVdsHwProviderStoragePools.QueryStoragePools
IVdsHwProviderStoragePools::QueryStoragePools
QueryStoragePools
QueryStoragePools method
QueryStoragePools method
IVdsHwProviderStoragePools interface
base.ivdshwproviderstoragepools_querystoragepools
vds/IVdsHwProviderStoragePools::QueryStoragePools
vdshwprv/IVdsHwProviderStoragePools::QueryStoragePools
base\ivdshwproviderstoragepools_querystoragepools.htm
base
308c9821-927d-4b90-854d-b050f3730c22
08/05/2022
IVdsHwProviderStoragePools interface,QueryStoragePools method, IVdsHwProviderStoragePools.QueryStoragePools, IVdsHwProviderStoragePools::QueryStoragePools, QueryStoragePools, QueryStoragePools method, QueryStoragePools method,IVdsHwProviderStoragePools interface, base.ivdshwproviderstoragepools_querystoragepools, vds/IVdsHwProviderStoragePools::QueryStoragePools, vdshwprv/IVdsHwProviderStoragePools::QueryStoragePools
vds.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Uuid.lib
Windows
19H1
IVdsHwProviderStoragePools::QueryStoragePools
vds/IVdsHwProviderStoragePools::QueryStoragePools
c++
APIRef
kbSyntax
COM
Uuid.lib
Uuid.dll
IVdsHwProviderStoragePools.QueryStoragePools

IVdsHwProviderStoragePools::QueryStoragePools

-description

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

Returns an IEnumVdsObject enumeration object containing a list of the storage pools managed by the hardware provider.

-parameters

-param ulFlags [in]

A bitmask of one or more VDS_STORAGE_POOL_TYPE flags that specify the types of storage pools to be queried. One of the flags must be either VDS_SPT_CONCRETE or VDS_SPT_PRIMORDIAL. The default value of this parameter is zero. A value of zero means that all storage pools should be queried.

-param ullRemainingFreeSpace [in]

The minimum amount of free space, in bytes, that each storage pool must contain. The default value for this parameter is zero. A value of zero means that the storage pools can contain any amount of free space.

-param pPoolAttributes [in]

A pointer to a VDS_POOL_ATTRIBUTES structure that specifies the attribute values that the returned storage pools must have. The default value for this parameter is NULL. A value of NULL means that the storage pools can have any attribute values.

-param ppEnum [out]

The address of an IEnumVdsObject interface pointer that can be used to enumerate the storage pools. For more information, see Working with Enumeration Objects. Callers must release the interface and each of the storage pool objects when they are no longer needed by calling the IUnknown::Release method. This parameter is required and cannot be NULL.

-returns

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 completed successfully.

-remarks

If the hardware provider does not manage any storage pools, this method returns an empty enumeration object.

If a non-NULL value is specified in the pPoolAttributes parameter, this method returns only storage pools that satisfy all of the attributes that are specified in the VDS_POOL_ATTRIBUTES structure. If any minimum and maximum attributes are specified, the storage pools that are returned must match these attributes exactly. The hint attributes are used as hints to further filter the storage pools that satisfy all the specified attributes. If a specified attribute does not apply to any of the storage pools, this method returns S_OK with an empty enumeration object.

-see-also

IVdsHwProviderStoragePools