CIM_ElementSettingData class

Represents the association between managed elements and applicable setting data. This association also describes whether this is a default or current setting. Each non-null, non-key property of the associated setting data instance defines a setting value for the associated managed element.

The properties IsDefault, IsCurrent, IsNext, IsMinimum, and IsMaximum further qualify those setting values. The referenced setting data instance does not reflect the current desired state of the referenced managed element unless IsCurrent = "Is Current". When the IsMinimum and/or IsMaximum properties have the value "Is Minimum" or "Is Maximum" respectively, the referenced setting data instance reflects desired minimum or maximum values respectively. When IsMinimum and IsMaximum have any other value, the referenced setting data reflects actual desired values.

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.

Syntax

class CIM_ElementSettingData
{
  CIM_ManagedElement REF ManagedElement;
  CIM_SettingData    REF SettingData;
  uint16             REF IsDefault;
  uint16                 IsCurrent;
  uint16                 IsNext;
};

Members

The CIM_ElementSettingData class has these types of members:

• Properties

Properties

The CIM_ElementSettingData class has these properties.

IsCurrent

Data type: uint16

Access type: Read-only

Indicates that the referenced setting is currently used in the operation of the element or that this information is unknown. For a given managed element and all instances of a setting data subclass, there shall be at most one instance of ElementSettingData which references the managed element and an instance of the SettingData subclass where there is a specified non-null, non-key property of the SettingData subclass, and the IsMaximum property on the referencing ElementSettingData instance has a value of "Is Maximum" or the IsMinimum property on the referencing ElementSettingData instance has a value of "Is Minimum" and the IsCurrent property on the referencing ElementSettingData instance has a value of "Is Current".

There shall be at most one instance of ElementSettingData which references a managed element and an instance of a SettingData subclass where the IsCurrent property has a value of "Is Current" and the IsMinimum property does not have a value of "Is Minimum" and the IsMaximum property does not have a value of "Is Maximum".

Unknown (0)

Is Current (1)

Is Not Current (2)

IsDefault

Data type: uint16

Access type: Read-only

Indicates that the referenced setting is a default setting for the element or that this information is unknown.

Unknown (0)

Is Default (1)

Is Not Default (2)

IsNext

Data type: uint16

Access type: Read-only

Indicates whether or not the referenced setting is the next setting to be applied. For example, the application could occur on a reinitialization, reset, or reconfiguration request. This could be a permanent setting, or a setting used only one time, as indicated by the flag. If it is a permanent setting then the setting is applied every time the managed element reinitializes, until this flag is manually reset. However, if it is single use, then the flag is automatically cleared after the settings are applied.

If this flag is specified (that is, set to a value other than "Unknown"), then this takes precedence over any SettingData that may have been specified as Default. For example: If the managed element is a computer system, and the value of this flag is "Is Next", then the setting will be effective next time the system resets. Unless this flag is changed, it will persist for subsequent system resets. However, if this flag is set to "Is Next For Single Use", then this setting will only be used once and the flag would be reset after that to "Is Not Next". In the preceding example, if the system restarts in a quick succession, the setting will not be used at the second restart.

Unknown (0)

Is Next (1)

Is Not Next (2)

Is Next For Single Use (3)

ManagedElement

Data type: CIM_ManagedElement

Access type: Read-only

Qualifiers: Key

The managed element.

SettingData

Data type: CIM_SettingData

Access type: Read-only

Qualifiers: Key

The SettingData object that is associated with the element.

Requirements

Namespace

Root\CIMV2