Edit

IVdsIscsiPortal::SetStatus method (vdshwprv.h)

  • Article

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

Not supported.

Sets the status of a portal to the specified value.

Syntax

HRESULT SetStatus(
  [in] VDS_ISCSI_PORTAL_STATUS status
);

Parameters

[in] status

Values enumerated by VDS_ISCSI_PORTAL_STATUS. Only VDS_IPS_ONLINE and VDS_IPS_OFFLINE enumeration values are supported; the remaining values are only to be used by a provider to report status.

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 Description
S_OK
 The status was set successfully.
VDS_E_PROVIDER_CACHE_CORRUPT
 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
 The portal object is no longer present.
VDS_E_ANOTHER_CALL_IN_PROGRESS
 Another operation is in progress. This operation cannot proceed until the previous operations are complete.
VDS_E_NOT_SUPPORTED
 The 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 vdshwprv.h
Library Uuid.lib
Redistributable VDS 1.1

See also

IVdsIscsiPortal

VDS_ISCSI_PORTAL_STATUS