IVdsLun::RemovePlex method (vdshwprv.h)

Article
02/09/2023

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

Removes a plex from a LUN.

Syntax

HRESULT RemovePlex(
  [in]  VDS_OBJECT_ID plexId,
  [out] IVdsAsync     **ppAsync
);

Parameters

[in] plexId

The GUID of the LUN plex to be removed.

[out] ppAsync

The address of an IVdsAsync interface pointer, which VDS initializes on return. Callers must release the interface. Use this interface to cancel, wait for, or query the status of the operation.

If you call IVdsAsync::Wait on this method and a success HRESULT value is returned, you must release the interfaces returned in the VDS_ASYNC_OUTPUT structure 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
VDS_E_PROVIDER_CACHE_CORRUPT 0x8004241FL	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.
VDS_E_OBJECT_DELETED 0x8004240BL	The LUN object is no longer present.
VDS_E_OBJECT_STATUS_FAILED 0x80042431L	The LUN is in a failed state and is unable to perform the requested operation.
VDS_E_ANOTHER_CALL_IN_PROGRESS 0x80042404L	Another operation is in progress; this operation cannot proceed until the previous operation or operations are complete.
VDS_E_OBJECT_NOT_FOUND 0x80042405L	Can be returned from any method that takes a VDS_OBJECT_ID constant. This return value indicates that the identifier does not refer to an existing object.

Remarks

The removed plex ceases to exist, and VDS frees the extents. A caller cannot remove a standalone LUN plex. Note that a LUN can lose its fault tolerance because of this operation. For example, if the operation transforms the LUN from mirrored to simple, the LUN is no longer fault tolerant.

Implementers must return a pointer to the IVdsAsync interface for this method, regardless of whether the call initiates an asynchronous operation.

If a caller invokes the RemovePlex method with the plexId parameter set to a value that is not valid, you should return VDS_E_OBJECT_NOT_FOUND.

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