IVdsControllerPort::GetProperties method (vds.h)
[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]
Retrieves the properties of a controller port.
Syntax
HRESULT GetProperties(
[out] VDS_PORT_PROP *pPortProp
);
Parameters
[out] pPortProp
The address of a member of the VDS_PORT_PROP structure that is allocated and passed in by the caller. VDS allocates memory for the pwszFriendlyName and pwszIdentification strings. Callers must free the strings by using the CoTaskMemFree function.
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 |
|---|---|
|
The properties were successfully retrieved. |
|
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. |
|
The cache of the provider is corrupted. This indicates a software or communication problem inside a provider that caches information about the attached devices. The caller can use the IVdsHwProvider::Reenumerate method followed by the IVdsHwProvider::Refresh method to restore the cache. |
|
The controller port object is no longer present. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | vds.h |