IVdsController::GetPortProperties method (vdshwprv.h)
[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 the specified controller port.
Syntax
HRESULT GetPortProperties(
[in] SHORT sPortNumber,
[out] VDS_PORT_PROP *pPortProp
);
Parameters
[in] sPortNumber
The number of the port. Port numbers are permanent. Ports are numbered from 0.
[out] pPortProp
The address of a VDS_PORT_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.
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 |
|---|---|
|
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. |
|
The controller object is no longer present. |
|
This operation or combination of parameters is not supported by this provider. |
Remarks
Use the IVdsController::GetProperties method to get the total number of ports.
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 |