Skip to content

Latest commit

 

History

History
134 lines (109 loc) · 4.52 KB

nf-vdshwprv-ivdsdrive-getproperties.md

File metadata and controls

134 lines (109 loc) · 4.52 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:vdshwprv.IVdsDrive.GetProperties
IVdsDrive::GetProperties (vdshwprv.h)
The IVdsDrive::GetProperties (vdshwprv.h) method returns the properties of a drive object.
GetProperties
GetProperties method [VDS]
GetProperties method [VDS]
IVdsDrive interface
IVdsDrive interface [VDS]
GetProperties method
IVdsDrive.GetProperties
IVdsDrive::GetProperties
base.ivdsdrive_getproperties
vds/IVdsDrive::GetProperties
vdshwprv/IVdsDrive::GetProperties
base\ivdsdrive_getproperties.htm
base
31556be6-ff03-492f-a7a6-dec37a63e88d
08/08/2022
GetProperties, GetProperties method [VDS], GetProperties method [VDS],IVdsDrive interface, IVdsDrive interface [VDS],GetProperties method, IVdsDrive.GetProperties, IVdsDrive::GetProperties, base.ivdsdrive_getproperties, vds/IVdsDrive::GetProperties, vdshwprv/IVdsDrive::GetProperties
vdshwprv.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
Uuid.lib
Windows
19H1
IVdsDrive::GetProperties
vdshwprv/IVdsDrive::GetProperties
c++
APIRef
kbSyntax
COM
Uuid.lib
Uuid.dll
IVdsDrive.GetProperties

IVdsDrive::GetProperties

-description

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

Returns the properties of a drive object.

-parameters

-param pDriveProp [out]

The address of the VDS_DRIVE_PROP structure allocated and passed in by the caller. VDS allocates memory for the pwszFriendlyName and pwszIdentification member strings. Callers must free the strings by using the CoTaskMemFree function.

-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/value Description
VDS_S_PROPERTIES_INCOMPLETE
0x00042715L
Some but not all of the properties were successfully retrieved. Note that there are many possible reasons for failing to retrieve all properties, including device removal.
VDS_E_PROVIDER_CACHE_CORRUPT
0x8004241FL
This return value signals a software or communication problem inside a provider that caches information about the array. Use the IVdsHwProvider::Reenumerate method followed by the IVdsHwProvider::Refresh method to restore the cache.
VDS_E_OBJECT_DELETED
0x8004240BL
The drive object is no longer present.

-see-also

IVdsDrive

IVdsHwProvider::Reenumerate

IVdsHwProvider::Refresh

VDS_DRIVE_PROP