Win32 Classes


Win32_MappedLogicalDisk Class

The Win32_MappedLogicalDisk WMI class represents network storage devices that are mapped as logical disks on the computer system.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties and methods are in alphabetic order, not MOF order.

Syntax

class Win32_MappedLogicalDisk : CIM_LogicalDisk
{
  uint16   Access;
  uint16   Availability;
  uint64   BlockSize;
  string   Caption;
  boolean  Compressed;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   Description;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  string   FileSystem;
  uint64   FreeSpace;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint32   MaximumComponentLength;
  string   Name;
  uint64   NumberOfBlocks;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   ProviderName;
  string   Purpose;
  boolean  QuotasDisabled;
  boolean  QuotasIncomplete;
  boolean  QuotasRebuilding;
  string   SessionID;
  uint64   Size;
  string   Status;
  uint16   StatusInfo;
  boolean  SupportsDiskQuotas;
  boolean  SupportsFileBasedCompression;
  string   SystemCreationClassName;
  string   SystemName;
  string   VolumeName;
  string   VolumeSerialNumber;
};

Methods

The Win32_MappedLogicalDisk class defines the following methods.

MethodDescription

Reset

Not implemented. To implement this method, see the Reset method in CIM_LogicalDisk.

SetPowerState

Not implemented. To implement this method, see the SetPowerState method in CIM_LogicalDisk.

 

Properties

The Win32_MappedLogicalDisk class defines the following properties.

Access
Data type: uint16
Access type: Read-only

Device access state. This property is inherited from CIM_StorageExtent.

ValueMeaning
0

Unknown

1

Readable

2

Writeable

3

Read/Write Supported

4

Write Once

 

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Running or Full Power

4 (0x4)

Warning

5 (0x5)

In Test

6 (0x6)

Not Applicable

7 (0x7)

Power Off

8 (0x8)

Offline

9 (0x9)

Off Duty

10 (0xA)

Degraded

11 (0xB)

Not Installed

12 (0xC)

Install Error

13 (0xD)

Power Save - Unknown

The device is known to be in a power save mode, but its exact status is unknown.

14 (0xE)

Power Save - Low Power Mode

The device is in a power save state but still functioning and can exhibit degraded performance.

15 (0xF)

Power Save - Standby

The device is not functioning, but can be brought to full power quickly.

16 (0x10)

Power Cycle

17 (0x11)

Power Save - Warning

The device is in a warning state, though also in a power save mode.

 

BlockSize
Data type: uint64
Access type: Read-only
Qualifiers: Units(Bytes)

Size, in bytes, of the blocks that form this storage extent. If this concept is not valid for the device type, the value is 1. This property is inherited from CIM_StorageExtent.

For more information about using uint64 values in scripts, see Scripting in WMI.

Caption
Data type: string
Access type: Read-only

Short description (one-line string) of the object. This property is inherited from CIM_ManagedSystemElement.

Compressed
Data type: boolean
Access type: Read-only

If True, the file is compressed. This property is inherited from CIM_ManagedSystemElement.

ConfigManagerErrorCode
Data type: uint32
Access type: Read-only

Windows Configuration Manager error code.

ValueMeaning
0 (0x0)

Device is working properly.

1 (0x1)

Device is not configured correctly.

2 (0x2)

Windows cannot load the driver for this device.

3 (0x3)

Driver for this device might be corrupted, or the system may be low on memory or other resources.

4 (0x4)

Device is not working properly. One of its drivers or the registry might be corrupted.

5 (0x5)

Driver for the device requires a resource that Windows cannot manage.

6 (0x6)

Boot configuration for the device conflicts with other devices.

7 (0x7)

Cannot filter.

8 (0x8)

Driver loader for the device is missing.

9 (0x9)

Device is not working properly. The controlling firmware is incorrectly reporting the resources for the device.

10 (0xA)

Device cannot start.

11 (0xB)

Device failed.

12 (0xC)

Device cannot find enough free resources to use.

13 (0xD)

Windows cannot verify the device's resources.

14 (0xE)

Device cannot work properly until the computer is restarted.

15 (0xF)

Device is not working properly due to a possible re-enumeration problem.

16 (0x10)

Windows cannot identify all of the resources that the device uses.

17 (0x11)

Device is requesting an unknown resource type.

18 (0x12)

Device drivers must be reinstalled.

19 (0x13)

Failure using the VxD loader.

20 (0x14)

Registry might be corrupted.

21 (0x15)

System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device.

22 (0x16)

Device is disabled.

23 (0x17)

System failure. If changing the device driver is ineffective, see the hardware documentation.

24 (0x18)

Device is not present, not working properly, or does not have all of its drivers installed.

25 (0x19)

Windows is still setting up the device.

26 (0x1A)

Windows is still setting up the device.

27 (0x1B)

Device does not have a valid log configuration.

28 (0x1C)

Device drivers are not installed.

29 (0x1D)

Device is disabled. The device firmware did not provide the required resources.

30 (0x1E)

Device is using an IRQ resource that another device is using.

31 (0x1F)

Device is not working properly. Windows cannot load the required device drivers.

 

ConfigManagerUserConfig
Data type: boolean
Access type: Read-only

If True, the device is using a user-defined configuration. This property is inherited from CIM_LogicalDevice.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen(256)

Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, this property allows all instances of this class and its subclasses to be uniquely identified. This property is inherited from CIM_LogicalDevice.

Description
Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only
Qualifiers: Key

Unique identifier of the memory array. This property is inherited from CIM_LogicalDevice.

Example: "Memory Array 1"

ErrorCleared
Data type: boolean
Access type: Read-only

If True, the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice.

ErrorDescription
Data type: string
Access type: Read-only

More information about the error recorded in LastErrorCode, and information on any corrective actions that can be taken. This property is inherited from CIM_LogicalDevice.

ErrorMethodology
Data type: string
Access type: Read-only

Types of error checking used by the hardware. This property is inherited from CIM_StorageExtent.

FileSystem
Data type: string
Access type: Read-only

Access type: Read-only

File system on the logical disk.

Example: "NTFS"

FreeSpace
Data type: uint64
Access type: Read-only
Qualifiers: Units(Bytes)

Space available on the logical disk. This property is inherited from CIM_LogicalDisk.

For more information about using uint64 values in scripts, see Scripting in WMI.

InstallDate
Data type: datetime
Access type: Read-only

Access type: Read-only

Date and time the object was installed. This property does not require a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode
Data type: uint32
Access type: Read-only

Last error code reported by the logical device. This property is inherited from CIM_LogicalDevice.

MaximumComponentLength
Data type: uint32
Access type: Read-only

Contains the maximum length of a file-name component supported by the Windows drive.

Example: 255

Name
Data type: string
Access type: Read-only

Object label. This property is inherited from CIM_ManagedSystemElement.

NumberOfBlocks
Data type: uint64
Access type: Read-only

Total number of consecutive blocks, each block the size of the value contained in the BlockSize property, which form this storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is 1, this property is the total size of the storage extent. This property is inherited from CIM_StorageExtent.

For more information about using uint64 values in scripts, see Scripting in WMI.

PNPDeviceID
Data type: string
Access type: Read-only

Windows Plug and Play device identifier of the logical device. This property is inherited from CIM_LogicalDevice.

Example: "*PNP030b"

PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only

Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.

ValueMeaning
0 (0x0)

Unknown

1 (0x1)

Not Supported

2 (0x2)

Disabled

3 (0x3)

Enabled

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

4 (0x4)

Power Saving Modes Entered Automatically

The device can change its power state based on usage or other criteria.

5 (0x5)

Power State Settable

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

6 (0x6)

Power Cycling Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle).

7 (0x7)

Timed Power-On Supported

The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on.

 

PowerManagementSupported
Data type: boolean
Access type: Read-only

If True, the device can be power-managed (can be put into suspend mode, and so on). The property does not indicate that power management features are currently enabled, only that the logical device is capable of power management. This property is inherited from CIM_LogicalDevice.

ProviderName
Data type: string
Access type: Read-only

Network path name to the logical device.

Purpose
Data type: string
Access type: Read-only

Free-form string that describes the media and its use. This property is inherited from CIM_StorageExtent.

QuotasDisabled
Data type: boolean
Access type: Read-only

If True, quota management is not enabled for this volume.

QuotasIncomplete
Data type: boolean
Access type: Read-only

If True, quota management was used but has been disabled. Incomplete refers to the information left in the file system after quota management has been disabled.

QuotasRebuilding
Data type: boolean
Access type: Read-only

If True, the file system is setting up for quota management.

SessionID
Data type: string
Access type: Read-only

ID of the user's session. The user may be connected using a local login or a terminal session.

Size
Data type: uint64
Access type: Read-only
Qualifiers: Units(Bytes)

Size of the logical disk.

For more information about using uint64 values in scripts, see Scripting in WMI.

Status
Data type: string
Access type: Read-only

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive may function properly, but predicts a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The Service status applies to administrative work, such as mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
StatusInfo
Data type: uint16
Access type: Read-only

State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.

ValueMeaning
1

Other

2

Unknown

3

Enabled

4

Disabled

5

Not Applicable

 

SupportsDiskQuotas
Data type: boolean
Access type: Read-only

If True, then the file system on which this network drive is mapped supports disk quotas.

SupportsFileBasedCompression
Data type: boolean
Access type: Read-only

If True, the logical disk partition supports file-based compression, such as is the case with NTFS. This property is False, when the Compressed property is True.

SystemCreationClassName
Data type: string
Access type: Read-only

Value of the scoping computer's CreationClassName property. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key

Name of the scoping system. This property is inherited from CIM_LogicalDevice.

VolumeName
Data type: string
Access type: Read-only
Qualifiers: Key

Volume name of the logical disk. This property value can have a maximum of 32 characters.

VolumeSerialNumber
Data type: string
Access type: Read-only

Volume serial number of the logical disk. This property value can have a maximum of 11 characters. This property is inherited from CIM_LogicalDevice.

Example: "A8C3-D032"

Remarks

The instances returned for this class are as follows, supposing that user A is enumerating the instances:

  • The provider looks for a logon session of user A on that machine:

    • If there is one (and only one) such logon session, then the provider returns the mapped drives of that session.
    • If there is more than one session for user A on the machine, then no mapped drive instances are returned (because the provider has no reasonable way of deciding which session to use).

  • If there are no sessions of user A running, and there is a locally logged on user B:

    • If there is a single session for user B, then the provider impersonates A and returns the mapped drives of user B. This case supports the scenario of help desk wanting to see the instances of a locally logged on user. However, whether instances are returned depends on the Local Security Policy settings in the Control Panel Administrative Tools. If the following policy is set to "Object Creator", then no mapped drive instances are returned, even if A is a member of the Administrators group:

      "System object: default owner for objects created by members of the administrators group."

      On Windows XP, the default setting for this security policy is "Object Creator". Starting with Windows Vista, this local policy has been removed.

    • Again, if there is more than one session of user B running on the machine, then the provider has no way of deciding which to use. In this case, no mapped drive instances are returned.

Examples

For script code examples, see WMI Tasks for Scripts and Applications and the TechNet ScriptCenter Script Repository.

For C++ code examples, see WMI C++ Application Examples.

Requirements

Minimum supported clientWindows XP
Minimum supported serverWindows Server 2003
MOFCimwin32.mof
DLLCimwin32.dll
Namespace\root\cimv2

See Also

Computer System Hardware Classes

Send comments about this topic to Microsoft

Build date: 11/3/2009

Tags :


Page view tracker