Edit

IVdsLunMpio::SetLoadBalancePolicy 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.]

Sets the load balance policy on the LUN.

Syntax

HRESULT SetLoadBalancePolicy(
  VDS_LOADBALANCE_POLICY_ENUM policy,
  VDS_PATH_POLICY             *pPaths,
  LONG                        lNumberOfPaths
);

Parameters

policy

The load balance policy enumerated by the
VDS_LOADBALANCE_POLICY_ENUM enumeration.

pPaths

A pointer to an array of members of the VDS_PATH_POLICY structure that contain the path-specific policy information.

lNumberOfPaths

The number of members of the VDS_PATH_POLICY structure in the array pointed to by the pPaths 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
S_OK
 The load balance policy was successfully set.
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 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 previous operations are complete.

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

See also

IVdsLunMpio

IVdsLunMpio::GetLoadBalancePolicy

VDS_LOADBALANCE_POLICY_ENUM

VDS_PATH_POLICY