IVdsIscsiTarget::SetFriendlyName method (vds.h)

  • Article

[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 the target.

Syntax

HRESULT SetFriendlyName(
  [in] LPWSTR pwszFriendlyName
);

Parameters

[in] pwszFriendlyName

A string specifying the friendly name to assign to the target. This corresponds to the iSCSI alias.

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
S_OK
 The friendly name was set successfully.
VDS_S_NAME_TRUNCATED
0x00042700L
 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 pwszFriendlyName parameter.
VDS_E_PROVIDER_CACHE_CORRUPT
0x8004241FL
 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.
VDS_E_OBJECT_DELETED
0x8004240BL
 The target object is no longer present.
VDS_E_ANOTHER_CALL_IN_PROGRESS
0x80042404L
 Another operation is in progress; this operation cannot proceed until the previous operations are complete.
VDS_E_NOT_SUPPORTED
0x80042400L
 This operation or combination of parameters 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 vds.h
Library Uuid.lib
Redistributable VDS 1.1

See also

IVdsIscsiTarget