IVdsIscsiPortalGroup::RemovePortal 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.]

Removes a portal from a portal group.

Syntax

HRESULT RemovePortal(
  [in]  VDS_OBJECT_ID portalId,
  [out] IVdsAsync     **ppAsync
);

Parameters

[in] portalId

The VDS_OBJECT_ID of the portal to be removed from the portal group.

[out] ppAsync

The address of an IVdsAsync interface pointer. VDS initializes the interface on return. Callers must release the interface. Use this interface to cancel, wait for, or query the status of the operation. If IVdsAsync::Wait is called and a success HRESULT value is returned, the interfaces returned in the VDS_ASYNC_OUTPUT structure must be released by calling the IUnknown::Release method on each interface pointer. However, if Wait returns a failure HRESULT value, or if the pHrResult parameter of Wait receives a failure HRESULT value, the interface pointers in the VDS_ASYNC_OUTPUT structure are NULL and do not need to be released. You can test for success or failure HRESULT values by using the SUCCEEDED and FAILED macros defined in Winerror.h.

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 portal was removed successfully from the portal group.
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 portal group 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_OBJECT_NOT_FOUND
0x80042405L
The portalID parameter does not refer to an existing object.

Requirements

   
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

IVdsAsync

IVdsIscsiPortalGroup