IVdsLunNaming::SetFriendlyName 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.]
Sets the friendly name of a LUN.
Syntax
HRESULT SetFriendlyName(
LPWSTR pwszFriendlyName
);
Parameters
pwszFriendlyName
A pointer to a null-terminated string specifying the name to assign to the LUN.
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 name was successfully set. |
|
The name was set successfully but had to be truncated due to limitations in the subsystem. The name that was set might not match the name passed in the pwszName parameter. |
|
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 LUN object is no longer present. |
|
The LUN is in a failed state and is unable to perform the requested operation. |
|
Another operation is in progress. This operation cannot proceed until previous operations are complete. |
|
This operation is not supported by this provider. |
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 | vdshwprv.h |