This topic has not yet been rated - Rate this topic

Win32_TapeDrive class

The Win32_TapeDrive WMI class represents a tape drive on a computer system running Windows. Tape drives are primarily distinguished by the fact that they can only be accessed sequentially.

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

Syntax

class Win32_TapeDrive : CIM_TapeDrive
{
  uint16   Availability;
  uint16   Capabilities[];
  string   CapabilityDescriptions[];
  string   Caption;
  uint32   Compression;
  string   CompressionMethod;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  uint64   DefaultBlockSize;
  string   Description;
  string   DeviceID;
  uint32   ECC;
  uint32   EOTWarningZoneSize;
  boolean  ErrorCleared;
  string   ErrorDescription;
  string   ErrorMethodology;
  uint32   FeaturesHigh;
  uint32   FeaturesLow;
  string   Id;
  datetime InstallDate;
  uint32   LastErrorCode;
  string   Manufacturer;
  uint64   MaxBlockSize;
  uint64   MaxMediaSize;
  uint32   MaxPartitionCount;
  string   MediaType;
  uint64   MinBlockSize;
  string   Name;
  boolean  NeedsCleaning;
  uint32   NumberOfMediaSupported;
  uint32   Padding;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  uint32   ReportSetMarks;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
};

Members

The Win32_TapeDrive class has these types of members:

Methods
Properties

Methods

The Win32_TapeDrive class has these methods.

Method	Description
Reset	Not implemented. To implement this method, see the Reset method in CIM_TapeDrive.
SetPowerState	Not implemented. To implement this method, see the SetPowerState method in CIM_TapeDrive.

Properties

The Win32_TapeDrive class has these properties.

Availability

Data type: uint16
Access type: Read-only

Availability and status of the device. Inherited from CIM_LogicalDevice.

Value	Meaning
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)	Off Line
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 may exhibit degraded performance.
15 (0xF)	Power Save - Standby The device is not functioning, but could 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.

Capabilities

Data type: uint16 array
Access type: Read-only

Array of capabilities of the media access device. For example, the device may support Random Access, removable media and Automatic Cleaning. In this case, the values 3, 7, and 9 would be written to the array. This property is inherited from CIM_MediaAccessDevice.

Value	Meaning
0	Unknown
1	Other
2	Sequential Access
3	Random Access
4	Supports Writing
5	Encryption
6	Compression
7	Supports Removable Media
8	Manual Cleaning
9	Automatic Cleaning
10	SMART Notification
11	Supports Dual-Sided Media
12	Predismount Eject Not Required

CapabilityDescriptions

Data type: string array
Access type: Read-only

Array of free-form strings providing more detailed explanations for any of the access device features indicated in the Capabilities array. Note that 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
Qualifiers: MaxLen (64)

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

Compression

Data type: uint32
Access type: Read-only

If TRUE, hardware data compression is enabled.

Value	Meaning
0	FALSE
1	TRUE

CompressionMethod

Data type: string
Access type: Read-only

Free-form string indicating the algorithm or tool used by the device to support compression. If it is not possible or not desired to describe the compression scheme (perhaps because it is not known), use the following words: "Unknown" to represent that it is not known whether the device supports compression capabilities or not; "Compressed" to represent that the device supports compression capabilities but either its compression scheme is not known or not disclosed; and "Not Compressed" to represent that the device does not support compression capabilities. This property is inherited from CIM_MediaAccessDevice.

ConfigManagerErrorCode

Data type: uint32
Access type: Read-only

Win32 Configuration Manager error code.

Value	Meaning
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 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.

DefaultBlockSize

Data type: uint64
Access type: Read-only

Default block size, in bytes, for this 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

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 tape drive with other devices on the system. This property is inherited from CIM_LogicalDevice.

ECC

Data type: uint32
Access type: Read-only

If TRUE, the device supports hardware error correction.

Value	Meaning
0	FALSE
1	TRUE

EOTWarningZoneSize

Data type: uint32
Access type: Read-only

Zone size for the end of tape (EOT) warning. This property is inherited from CIM_TapeDrive.

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

Free-form string supplying more information about the error recorded in LastErrorCode, and information about any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice.

ErrorMethodology

Data type: string
Access type: Read-only

Free-form string describing the type of error detection and correction supported by this device. This property is inherited from CIM_MediaAccessDevice.

FeaturesHigh

Data type: uint32
Access type: Read-only

High-order 32 bits of the device features flag.

FeaturesLow

Data type: uint32
Access type: Read-only

Low-order 32 bits of the device features flag.

Id

Data type: string
Access type: Read-only

Manufacturer's identifying name of the Windows CD ROM drive.

Example: "PLEXTOR CD-ROM PX-12CS 1.01"

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.

Manufacturer

Data type: string
Access type: Read-only

Manufacturer of the Windows CD-ROM drive.

Example: "PLEXTOR"

MaxBlockSize

Data type: uint64
Access type: Read-only

Maximum block size, in bytes, for media accessed by this 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 this device. This property is inherited from CIM_MediaAccessDevice.

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

MaxPartitionCount

Data type: uint32
Access type: Read-only

Maximum partition count for the tape drive. This property is inherited from CIM_TapeDrive.

MediaType

Data type: string
Access type: Read-only

Media type used by (or accessed by) this device. In this case, it is set to "Tape Drive".

MinBlockSize

Data type: uint64
Access type: Read-only

Minimum block size, in bytes, for media accessed by this 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, the 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 property. This property is inherited from CIM_MediaAccessDevice.

NumberOfMediaSupported

Data type: uint32
Access type: Read-only

Maximum number of individual media which can be supported or inserted in the media access device (when supported). This property is inherited from CIM_MediaAccessDevice.

Padding

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

Number of bytes inserted between blocks on a tape media. This property is inherited from CIM_TapeDrive.

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.

Value	Meaning
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.

ReportSetMarks

Data type: uint32
Access type: Read-only

If TRUE, setmark reporting is enabled. Setmark reporting makes use of a specialized recorded element that does not contain user data. This recorded element is used to provide a segmentation scheme that is hierarchically superior to filemarks. Setmarks provide faster positioning on high-capacity tapes.

Value	Meaning
0	FALSE
1	TRUE

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

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 be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from CIM_ManagedSystemElement.

The values are:

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

Value	Meaning
1	Other
2	Unknown
3	Enabled
4	Disabled
5	Not Applicable

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

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

Remarks

The Win32_TapeDrive class is derived from CIM_TapeDrive.

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 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Namespace	\root\CIMV2
MOF	Cimwin32.mof
DLL	Cimwin32.dll

Community Additions

ADD

Win32_TapeDrive class

Syntax

Members

Methods

Properties

Remarks

Examples

Requirements

See also

Community Additions