IVdsLun::AssociateControllers 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.]

Sets the subsystem controllers to active or inactive with respect to the LUN.

Syntax

HRESULT AssociateControllers(
  [in] VDS_OBJECT_ID *pActiveControllerIdArray,
  [in] LONG          lNumberOfActiveControllers,
  [in] VDS_OBJECT_ID *pInactiveControllerIdArray,
  [in] LONG          lNumberOfInactiveControllers
);

Parameters

[in] pActiveControllerIdArray

A pointer to an array of controller GUIDs. The provider sets these controllers to active. This array includes controllers already set to active that are to remain so.

[in] lNumberOfActiveControllers

The number of controllers specified in the pActiveControllerArray parameter.

[in] pInactiveControllerIdArray

A pointer to an array of controller GUIDs. The provider sets these controllers to inactive. This array includes controllers already set to inactive that are to remain so.

[in] lNumberOfInactiveControllers

The number of controllers specified in the pInactiveControllerIdArray parameter.

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	One or more of the GUIDs specified in the active or inactive arrays do not refer to an existing object.
VDS_E_NOT_SUPPORTED 0x80042400L	This operation or combination of parameters is not supported by this provider.

Remarks

The caller must include each subsystem controller in exactly one of either the pActiveControllerIdArray parameter or the pInactiveControllerIdArray parameter for each method call. The composition of the pActiveControllerIdArray and pInactiveControllerIdArray parameters can be different for each of the subsystem LUNs. Most subsystems implement only one active controller, but some allow for multiple active controllers.

Note The E_INVALIDARG return value can indicate that the caller did not specify all controllers in the subsystem. The AssociateControllers method requires that all controllers in the subsystem be present in one of the two arrays supplied.

Use the IVdsLun::QueryActiveControllers method to query controller associations. Use the IVdsController::QueryAssociatedLuns method to query the LUNs associated with a particular controller.

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