Msvm_S3DisplayController class

Article
05/31/2018

Represents the state of the emulated S3 controller that is present in each virtual machine configuration. Only one display controller can be active in a virtual machine at any time.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_S3DisplayController : CIM_DisplayController
{
  string   Caption = "Display Controller";
  string   ElementName = "Display Controller";
  datetime InstallDate;
  string   Name = "Display Controller";
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 2;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_S3DisplayController";
  string   DeviceID = "Microsoft:GUID";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator = 4;
  datetime TimeOfLastReset;
  uint16   ProtocolSupported = 1;
  uint32   MaxNumberControlled = 1;
  string   ProtocolDescription = "Video";
  string   Description = "Microsoft Emulated Display Controller";
  string   VideoProcessor = "Virtual S3 Video Processor";
  uint16   VideoMemoryType = 2;
  string   OtherVideoMemoryType;
  uint32   NumberOfVideoPages = 1024;
  uint32   MaxMemorySupported = 4194304;
  uint16   AcceleratorCapabilities[] = 2;
  string   CapabilityDescriptions[] = { "Graphics Accelerator" };
};

Members

The Msvm_S3DisplayController class has these types of members:

Methods
Properties

Methods

The Msvm_S3DisplayController class has these methods.

Method	Description
EnableDevice	This method is not supported.
OnlineDevice	This method is not supported.
QuiesceDevice	This method is not supported.
RequestStateChange	This method is not supported.
Reset	This method is not supported.
RestoreProperties	This method is not supported.
SaveProperties	This method is not supported.
SetPowerState	This method is not supported.

Properties

The Msvm_S3DisplayController class has these properties.

AcceleratorCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_DisplayController.CapabilityDescriptions")

The graphics and 3D capabilities of the display controller. This property is inherited from CIM_DisplayController and it is set to 2 (Graphics Accelerator).

AdditionalAvailability

Data type: uint16 array
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")

This property is inherited from CIM_LogicalDevice and it is set to 6 (Not Applicable).

Availability

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")

This property is inherited from CIM_LogicalDevice and it is set to NULL.

CapabilityDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_DisplayController.AcceleratorCapabilities")

An array of free-form strings that provide more detailed explanations for any of the video accelerator features indicated in the AcceleratorCapabilities array. Note that each entry of this array is related to the entry in the AcceleratorCapabilities array that is located at the same index. This property is inherited from CIM_DisplayController and it is set to "Graphics Accelerator".

Caption

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

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Display Controller".

CreationClassName

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

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_S3DisplayController".

Description

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Video|004.18")

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Emulated Display Controller".

DeviceID

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

This property is inherited from CIM_LogicalDevice and it is set to "Microsoft:GUID".

ElementName

Data type: string
Access type: Read-only

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Display Controller" by default.

EnabledDefault

Data type: uint16
Access type: Read/write

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).

EnabledState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement and it is set to 2 (Enabled) or 3 (Disabled).

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

ErrorCleared

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")

This property is inherited from CIM_LogicalDevice but it is not used.

ErrorDescription

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")

This property is inherited from CIM_LogicalDevice but it is not used.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. This property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

IdentifyingDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")

This property is inherited from CIM_LogicalDevice and it is set to NULL.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32
Access type: Read-only
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")

This property is inherited from CIM_LogicalDevice but it is not used.

LocationIndicator

Data type: uint16
Access type: Read/write
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")

This property is inherited from CIM_LogicalDevice and it is set to 4 (Not Supported).

MaxMemorySupported

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

The maximum amount of memory supported, in bytes. This property is inherited from CIM_DisplayController and it is set to 4,194,304 (0x400000).

MaxNumberControlled

Data type: uint32
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.9")

The maximum number of directly addressable entities that are supported by this controller. A value of 0 should be used if the number is unknown or unlimited. The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller and it is set to 1.

MaxQuiesceTime

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")

This property is inherited from CIM_LogicalDevice but it is not used.

Name

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

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement and it is the same as the ElementName property.

NumberOfVideoPages

Data type: uint32
Access type: Read-only

The number of video pages supported given the current resolutions and available memory. This property is inherited from CIM_DisplayController and it is set to 1024.

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement and each array element is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement and it is always set to NULL.

OtherIdentifyingInfo

Data type: string array
Access type: Read-only
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

This property is inherited from CIM_LogicalDevice and it is set to NULL.

OtherVideoMemoryType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_DisplayController.VideoMemoryType")

The video memory type when the instance's VideoMemoryType property is 1 (Other). This property is inherited from CIM_DisplayController and it is set to NULL.

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")

This property is inherited from CIM_LogicalDevice but it is not used.

PowerManagementSupported

Data type: boolean
Access type: Read-only
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")

This property is inherited from CIM_LogicalDevice but it is not used.

PowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter

This property is inherited from CIM_LogicalDevice but it is not used.

ProtocolDescription

Data type: string
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.3"), ModelCorrespondence ("CIM_Controller.ProtocolSupported")

A free-form string that provides more information that is related to the protocol supported by the controller. This property is inherited from CIM_Controller and it is set to "Video".

ProtocolSupported

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Bus Port|004.2", "MIF.DMTF|Disks|003.3"), ModelCorrespondence ("CIM_Controller.ProtocolDescription")

The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller and it is set to 1 (Other).

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. A particular instance of CIM_EnabledLogicalElement might not support the RequestStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement and it is set to 2 (Enabled), 3 (Disabled), or 12 (Not Applicable).

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and each array element is always set to "OK".

StatusInfo

Data type: uint16
Access type: Read-only
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")

This property is inherited from CIM_LogicalDevice but it is not used.

SystemCreationClassName

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

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and it is set to "Msvm_ComputerSystem".

SystemName

Data type: string
Access type: Read-only
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The unique identifier for the scoping virtual system. This property is inherited from CIM_LogicalDevice.

TimeOfLastReset

Data type: datetime
Access type: Read-only

The last time the virtual computer system was powered on. This property is inherited from CIM_Controller.

TimeOfLastStateChange

Data type: datetime
Access type: Read-only

The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.

TotalPowerOnHours

Data type: uint64
Access type: Read-only
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

This property is inherited from CIM_LogicalDevice but it is not used.

VideoMemoryType

Data type: uint16
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|Video|004.6"), ModelCorrespondence ("CIM_DisplayController.OtherVideoMemoryType")

The type of video memory. This property is inherited from CIM_DisplayController and it is set to 2 (VRAM).

VideoProcessor

Data type: string
Access type: Read-only

A free-form string that describes the video processor/controller. This property is inherited from CIM_DisplayController and it is set to "Virtual S3 Video Processor".

Remarks

Access to the Msvm_S3DisplayController class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2008
End of client support	None supported
End of server support	Windows Server 2012 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Share via

Msvm_S3DisplayController class

Syntax

Members

Methods

Properties

Remarks

Requirements

See also

Additional resources