CIM_WORMDrive class

The CIM_WORMDrive class represents the capabilities and management of a WORM drive, a subtype of the media access device.

Important  The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

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

Syntax

class CIM_WORMDrive : CIM_MediaAccessDevice
{
  uint16   Availability;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  string   CompressionMethod;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint64   DefaultBlockSize;
  string   Description;
  string   DeviceID;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint64   MaxBlockSize;
  uint64   MaxMediaSize;
  uint64   MinBlockSize;
  string   Name;
  boolean  NeedsCleaning;
  uint32   NumberOfMediaSupported;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
};

Members

The CIM_WORMDrive class has these types of members:

Methods

The CIM_WORMDrive class has these methods.

MethodDescription
Reset

Requests a reset of the logical device. Not implemented by WMI.

SetPowerState

Defines the desired power state for a logical device and when a device should be put into that state. Not implemented by WMI.

 

Properties

The CIM_WORMDrive class has these properties.

Availability
Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

ValueMeaning
Other
1 (0x1)
Unknown
2 (0x2)
Running
3 (0x3)

Running or Full Power

Warning
4 (0x4)
In Test
5 (0x5)
Not Applicable
6 (0x6)
Power Off
7 (0x7)
Off Line
8 (0x8)
Off Duty
9 (0x9)
Degraded
10 (0xA)
Not Installed
11 (0xB)
Install Error
12 (0xC)
Power Save - Unknown
13 (0xD)

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

Power Save - Low Power Mode
14 (0xE)

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

Power Save - Standby
15 (0xF)

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

Power Cycle
16 (0x10)
Power Save - Warning
17 (0x11)

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

 

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

Capabilities of the media access device. This property is inherited from CIM_MediaAccessDevice.

ValueMeaning
0

Unknown

Other
1
Sequential access
2
Random access
3
Supports writing
4
Encryption
5
Compression
6
Supports removable media
7
Manual cleaning
8
Automatic cleaning
9
SMART notification
10
Supports dual-sided media
11

Distinguishes a device that can access both sides of dual-sided media from a device that reads only a single side and requires the media to be turned over.

Predismount eject not required
12

Indicates that the media does not have to be explicitly ejected from the device before being accessed by a picker element.

 

CapabilityDescriptions
Data type: string array
Access type: Read-only

Free-form strings that provide detailed descriptions for the access device features indicated in the Capabilities array.

Note  Each entry of this array is related to the entry in the Capabilities array that is located at the same index.

This property is inherited from CIM_MediaAccessDevice.

Caption
Data type: string
Access type: Read-only

Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

CompressionMethod
Data type: string
Access type: Read-only

Free-form string that indicates the algorithm or tool used to compress the logical file. If the compression scheme is unknown or not described, use "Unknown". If the logical file is compressed, but the compression scheme is unknown or not described, use "Compressed". If the logical file is not compressed, use "Not Compressed". This property is inherited from CIM_MediaAccessDevice.

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 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

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

DefaultBlockSize
Data type: uint64
Access type: Read-only

Default block size, in bytes, for the device. This property is inherited from CIM_MediaAccessDevice.

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

Description
Data type: string
Access type: Read-only

Textual description of the object. This property is inherited from CIM_ManagedSystemElement.

DeviceID
Data type: string
Access type: Read-only

Address or other identifying information to uniquely name the logical device. This property is inherited from CIM_LogicalDevice.

ErrorCleared
Data type: boolean
Access type: Read-only

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

ErrorDescription
Data type: string
Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform. This property is inherited from CIM_LogicalDevice.

ErrorMethodology
Data type: string
Access type: Read-only

Free-form string that describes the types of error detection and correction supported by the device. This property is inherited from CIM_MediaAccessDevice.

InstallDate
Data type: datetime
Access type: Read-only

Date and time the object was installed. This property does not need 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.

MaxBlockSize
Data type: uint64
Access type: Read-only

Maximum block size, in bytes, for media accessed by the device. This property is inherited from CIM_MediaAccessDevice.

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

MaxMediaSize
Data type: uint64
Access type: Read-only

Maximum size, in kilobytes, of media supported by the device. Kilobytes are interpreted as the number of bytes multiplied by 1000 (not the number of bytes multiplied by 1024). This property is inherited from CIM_MediaAccessDevice.

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

MinBlockSize
Data type: uint64
Access type: Read-only

Minimum block size, in bytes, for media accessed by the device. This property is inherited from CIM_MediaAccessDevice.

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

Name
Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NeedsCleaning
Data type: boolean
Access type: Read-only

If TRUE, the media access device needs cleaning. Whether manual or automatic cleaning is possible is indicated in the Capabilities array property. This property is inherited from CIM_MediaAccessDevice.

NumberOfMediaSupported
Data type: uint32
Access type: Read-only

When the media access device supports multiple individual media, this property defines the maximum number that can be supported or inserted. This property is inherited from CIM_MediaAccessDevice.

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
Unknown
0 (0x0)
Not Supported
1 (0x1)
Disabled
2 (0x2)
Enabled
3 (0x3)

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

Power Saving Modes Entered Automatically
4 (0x4)

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

Power State Settable
5 (0x5)

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.

Power Cycling Supported
6 (0x6)

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

Timed Power On Supported
7 (0x7)

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, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array. This property is inherited from CIM_LogicalDevice.

Status
Data type: string
Access type: Read-only

Current status of the object. This property is inherited from CIM_ManagedSystemElement.

Values include the following:

"OK"

"Error"

"Degraded"

"Unknown"

"Pred Fail"

"Starting"

"Stopping"

"Service"

"Stressed"

"NonRecover"

"No Contact"

"Lost Comm"

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.

Other (1 (0x1))
Unknown (2 (0x2))
Enabled (3 (0x3))
Disabled (4 (0x4))
Not Applicable (5 (0x5))
SystemCreationClassName
Data type: string
Access type: Read-only

Scoping system's creation class name. This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only

Scoping system's name. This property is inherited from CIM_LogicalDevice.

Remarks

The CIM_WORMDrive class is derived from CIM_MediaAccessDevice.

WMI does not implement this class.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

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 client

Windows XP

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft