SetUsage method of the MSFT_VirtualDisk class

Sets or changes the intended usage for the virtual disk.

Syntax

UInt32 SetUsage(
  [in]  UInt16 Usage,
  [in]  String OtherUsageDescription,
  [out] String ExtendedStatus
);

Parameters

Usage [in]

The new intended usage for the virtual disk.

This parameter is required and cannot be NULL.

Unknown (0)

Other (1)

Unrestricted (2)

Reserved for ComputerSystem (the block server) (3)

Reserved by Replication Services (4)

Reserved by Migration Services (5)

Local Replica Source (6)

Remote Replica Source (7)

Local Replica Target (8)

Remote Replica Target (9)

Local Replica Source or Target (10)

Remote Replica Source or Target (11)

Delta Replica Target (12)

Element Component (13)

Reserved as Pool Contributor (14)

Composite Volume Member (15)

Composite VirtualDisk Member (16)

Reserved for Sparing (17)

OtherUsageDescription [in]

If Usage is set to Other, this parameter is the string representation of a vendor-defined usage for this virtual disk. This parameter must be NULL if Usage is not Other.

ExtendedStatus [out]

A string that contains an embedded MSFT_StorageExtendedStatus object.

This parameter allows the storage provider to return extended (implementation-specific) error information.

Return value

Success (0)

Not Supported (1)

Unspecified Error (2)

Timeout (3)

Failed (4)

Invalid Parameter (5)

Access denied (40001)

There are not enough resources to complete the operation. (40002)

Cannot connect to the storage provider. (46000)

The storage provider cannot connect to the storage subsystem. (46001)

The storage pool could not complete the operation because its health or operational status does not permit it. (48006)

The storage pool could not complete the operation because its configuration is read-only. (48007)

The virtual disk could not complete the operation because another computer controls its configuration. (50002)

The virtual disk could not complete the operation because its health or operational status does not permit it. (50003)

Remarks

Not all virtual disks may allow this method. Those that do not will cause this method to return Not Supported.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Namespace Root\Microsoft\Windows\Storage
MOF Storagewmi.mof

See also

MSFT_VirtualDisk