Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CIM_CacheMemory class

The CIM_CacheMemory class defines the capabilities and management of cache memory.

Cache memory is the dedicated or allocated RAM where a processor first searches for data. Data in cache memory is quickly delivered to the processor and is usually described by its proximity to the processor (for example, primary or secondary cache). A disk drive that includes RAM allocated for holding the disk's most recently read or adjacent data (to speed up retrieval) is also modeled as cache memory.

Note  Cache memory is not an operating-system or application-level buffer; it is RAM that has been allocated for caching processor data.

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 inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class CIM_CacheMemory : CIM_Memory
{
  uint16   Access;
  uint8    AdditionalErrorData[];
  uint16   Associativity;
  uint16   Availability;
  uint64   BlockSize;
  uint16   CacheType;
  string   Caption;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  boolean  CorrectableError;
  string   CreationClassName;
  string   Description;
  string   DeviceID;
  uint64   EndingAddress;
  uint16   ErrorAccess;
  uint64   ErrorAddress;
  boolean  ErrorCleared;
  uint8    ErrorData;
  uint16   ErrorDataOrder;
  string   ErrorDescription;
  uint16   ErrorInfo;
  string   ErrorMethodology;
  uint64   ErrorResolution;
  datetime ErrorTime;
  uint32   ErrorTransferSize;
  uint32   FlushTimer;
  datetime InstallDate;
  uint32   LastErrorCode;
  uint16   Level;
  uint32   LineSize;
  string   Name;
  uint64   NumberOfBlocks;
  string   OtherErrorDescription;
  string   PNPDeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  PowerManagementSupported;
  string   Purpose;
  uint16   ReadPolicy;
  uint16   ReplacementPolicy;
  uint64   StartingAddress;
  string   Status;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  boolean  SystemLevelAddress;
  string   SystemName;
  uint16   WritePolicy;
};

Members

The CIM_CacheMemory class has these types of members:

Methods

The CIM_CacheMemory 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 the device should be put into that state. Not implemented by WMI.

 

Properties

The CIM_CacheMemory class has these properties.

Access
Data type: uint16
Access type: Read-only

Describes whether the media is readable, writeable, or both. "Unknown" and "Write Once" values can also be defined. This property is inherited from CIM_StorageExtent.

ValueMeaning
0

Unknown.

1

Readable.

2

Writeable.

3

Read/write supported.

4

Write once.

 

AdditionalErrorData
Data type: uint8 array
Access type: Read-only

Array of octets that hold additional error information. An example is Error Checking and Correcting (ECC) Syndrome, or the return of the check bits if a CRC-based error methodology is used. In the latter case, if a single-bit error is recognized and the CRC algorithm is known, the exact bit that failed can be determined. This type of data (ECC Syndrome, check-bit or parity-bit data, or other vendor supplied information) is included in this field. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

Associativity
Data type: uint16
Access type: Read-only

Enumeration that defines the system cache associativity.

ValueMeaning
1

Other

2

Unknown

3

Direct mapped

4

2-way set-associative

5

4-way set-associative

6

Fully associative

7

8-way set-associative

8

16-way set-associative

 

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

 

BlockSize
Data type: uint64
Access type: Read-only

Size, in bytes, of the blocks that form the storage extent. If a variable block size, then the maximum block size, in bytes, should be specified. If the block size is unknown, or if a block concept is not valid (for example, for aggregate extents, memory or logical disks), use 1. This property is inherited from CIM_StorageExtent.

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

CacheType
Data type: uint16
Access type: Read-only

Specifies instruction caching, data caching, or both. "Other" and "Unknown" also can be defined.

ValueMeaning
1

Other

2

Unknown

3

Instruction

4

Data

5

Unified

 

Caption
Data type: string
Access type: Read-only

Short textual description of the object. 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 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.

CorrectableError
Data type: boolean
Access type: Read-only

If TRUE, the most recent error was correctable. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

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.

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.

EndingAddress
Data type: uint64
Access type: Read-only

Ending address that is referenced by an application or operating system and mapped by a memory controller for this memory object. The ending address is specified in kilobytes. This property is inherited from CIM_Memory.

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

ErrorAccess
Data type: uint16
Access type: Read-only

Integer enumeration that indicates the memory access operation that caused the last error. The error type is described by the ErrorInfo property. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

ValueMeaning
1

Other

2

Unknown

3

Read

4

Write

5

Partial write

 

ErrorAddress
Data type: uint64
Access type: Read-only

Address of the last memory error. The type of error is described by the ErrorInfo property. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

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

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.

ErrorData
Data type: uint8
Access type: Read-only

Data captured during the last erroneous memory access. The data occupies the first n octets of the array that are necessary to hold the number of bits specified by the ErrorTransferSize property. If ErrorTransferSize is 0, then this property has no meaning. This property is inherited from CIM_Memory.

ErrorDataOrder
Data type: uint16
Access type: Read-only

Order of data stored in the ErrorData property; "Least Significant Byte First" or "Most Significant Byte First" can be specified. If ErrorTransferSize is 0, then this property has no meaning. This property is inherited from CIM_Memory.

ValueMeaning
0

Unknown.

1

Least significant byte first.

2

Most significant byte first.

 

ErrorDescription
Data type: string
Access type: Read-only

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

ErrorInfo
Data type: uint16
Access type: Read-only

Integer enumeration that describes the type of error that occurred most recently. For example, single-bit or double-bit errors can be specified using this property. The values 12-14 are undefined in the CIM schema because DMI mixes the semantics of the error type and whether it was correctable. Whether it was correctable is indicated in the CorrectableError property. This property is inherited from CIM_Memory.

ValueMeaning
1

Other.

2

Unknown.

3

OK.

4

Bad read.

5

Parity error.

6

Single-bit error.

7

Double-bit error.

8

Multi-bit error.

9

Nibble error.

10

Checksum error.

11

CRC error.

12

Undefined.

13

Undefined.

14

Undefined.

 

ErrorMethodology
Data type: string
Access type: Read-only

Specifies whether parity algorithms, CRC algorithms, ECC, or other mechanisms are used. Details on the algorithm can also be supplied. This property is inherited from CIM_StorageExtent.

ErrorResolution
Data type: uint64
Access type: Read-only

Specifies the range, in bytes, to which the last error can be resolved. For example, if error addresses are resolved to bit 11 (that is, on a typical page basis), then errors can be resolved to 4 KB boundaries and this property is set to 4000. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

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

ErrorTime
Data type: datetime
Access type: Read-only

Date and time that the last memory error occurred. The type of error is described by the ErrorInfo property. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

ErrorTransferSize
Data type: uint32
Access type: Read-only

Size of the data transfer, in bits, that caused the last error. A value of 0 indicates no error. If the ErrorInfo property is equal to 3 ("OK"), then this property should be set to 0. This property is inherited from CIM_Memory.

FlushTimer
Data type: uint32
Access type: Read-only

Maximum amount of time, in seconds, dirty lines or buckets may remain in the cache before they are flushed. A value of 0 indicates that a cache flush is not controlled by a flushing timer.

InstallDate
Data type: datetime
Access type: Read-only

Date and time when 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.

Level
Data type: uint16
Access type: Read-only

Specifies whether this is the primary, secondary or tertiary cache. "Other", "Unknown", and "Not Applicable" also can be defined.

ValueMeaning
1

Other.

2

Unknown.

3

Primary.

4

Secondary.

5

Tertiary.

6

Not applicable.

 

LineSize
Data type: uint32
Access type: Read-only

Size, in bytes, of a single cache bucket or line.

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.

NumberOfBlocks
Data type: uint64
Access type: Read-only

Total number of consecutive blocks, each block is the size of the value contained in the BlockSize property, which forms the 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.

OtherErrorDescription
Data type: string
Access type: Read-only

Free-form string that provides more information if the ErrorType property is set to 1 ("Other"). If not set to 1, this string has no meaning. This property is inherited from CIM_Memory.

PNPDeviceID
Data type: string
Access type: Read-only

Win32 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, that is, put into a power-save state. This property does not indicate that power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

If False, the integer value 1, for the string "Not Supported", should be the only entry in the PowerManagementCapabilities array.

This property is inherited from CIM_LogicalDevice.

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.

ReadPolicy
Data type: uint16
Access type: Read-only

Policy employed by the cache for handling read requests. If the read policy is determined individually, that is, for each request, then the value 6 ("Determination per I/O") should be specified. "Other" and "Unknown" are also valid values.

ValueMeaning
1

Other.

2

Unknown.

3

Read.

4

Read-ahead.

5

Read and read-ahead.

6

Determination per I/O.

 

ReplacementPolicy
Data type: uint16
Access type: Read-only

Integer enumeration describing the algorithm that determines which cache lines or buckets should be re-used.

ValueMeaning
1

Other.

2

Unknown.

3

Least recently used (LRU).

4

First-in, first-out (FIFO).

5

Last-in, first-out (LIFO).

6

Least frequently used (LFU.)

7

Most frequently used (MFU).

8

Data-dependent multiple algorithms.

 

StartingAddress
Data type: uint64
Access type: Read-only

Beginning address referenced by an application or operating system and mapped by a memory controller for this memory object. The starting address is specified in kilobytes. This property is inherited from CIM_Memory.

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

ValueMeaning
1 (0x1)

Other

2 (0x2)

Unknown

3 (0x3)

Enabled

4 (0x4)

Disabled

5 (0x5)

Not Applicable

 

SystemCreationClassName
Data type: string
Access type: Read-only

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

SystemLevelAddress
Data type: boolean
Access type: Read-only

If TRUE, the address information in the ErrorAddress property is a system-level address. If FALSE, it is a physical address. If the ErrorInfo property is equal to 3 ("OK"), then this property has no meaning. This property is inherited from CIM_Memory.

SystemName
Data type: string
Access type: Read-only

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

WritePolicy
Data type: uint16
Access type: Read-only

Defines whether the cache is write-back or write-through, or whether the information "Varies with Address" or is defined individually for each input/output. "Other" and "Unknown" also can be specified.

ValueMeaning
1

Other.

2

Unknown.

3

Write back.

4

Write through.

5

Varies with address.

6

Determination per I/O.

 

Remarks

The CIM_CacheMemory class is derived from CIM_Memory.

WMI does not implement this class. For more information about classes derived from CIM_CacheMemory, see Win32 Classes.

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.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Namespace

\root\CIMV2

MOF

CIMWin32.mof

DLL

CIMWin32.dll

 

 

Show:
© 2014 Microsoft