Msvm_S3DisplayController class

Article
01/07/2021

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.

Note

This class only applies to generation 1 virtual machines.

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   InstanceID;
  string   Caption = "Display Controller";
  string   Description = "Microsoft Emulated Display Controller";
  string   ElementName = "Display Controller";
  datetime InstallDate;
  string   Name = "Display Controller";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   EnabledState = 3;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  uint16   CreationClassName = "Msvm_S3DisplayController";
  string   DeviceID;
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability = 6;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = {6};
  uint64   MaxQuiesceTime;
  datetime TimeOfLastReset;
  uint16   ProtocolSupported = 1;
  uint32   MaxNumberControlled = 1;
  string   ProtocolDescription = "Video";
  string   VideoProcessor = "Virtual S3 Video Processor";
  uint16   VideoMemoryType = 2;
  string   OtherVideoMemoryType;
  uint32   NumberOfVideoPages = 32768;
  uint32   MaxMemorySupported = 134217728;
  uint16   AcceleratorCapabilities[] = { 2 };
  string   CapabilityDescriptions[] = { "Graphics Accelerator" };
  string   OtherVideoArchitecture;
  uint16   VideoArchitecture;
};

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	Requests a state change.
Reset	Resets the virtual device.
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

The graphics and 3D capabilities of the display controller. This property is inherited from CIM_DisplayController.

AdditionalAvailability

Data type: uint16 array
Access type: Read-only

Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice.

Availability

Data type: uint16
Access type: Read-only

The primary availability and status of the device. This property is inherited from CIM_LogicalDevice.

Value	Meaning
6	Not Applicable

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

CapabilityDescriptions

Data type: string array
Access type: Read-only

An array of free-form strings that provide more detailed explanations for any of the video accelerator features indicated in the AcceleratorCapabilities array. 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.

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

CreationClassName

Data type: uint16
Access type: Read-only

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

Description

Data type: string
Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement.

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

DeviceID

Data type: string
Access type: Read-only

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

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement.

EnabledDefault

Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
2	Enabled
3	Disabled

EnabledState

Data type: string
Access type: Read-only

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 always set to 2 (Enabled) or 3 (Disabled).

Value	Meaning
2	Enabled
3	Disabled

ErrorCleared

Data type: boolean
Access type: Read-only

Indicates whether the error reported in LastErrorCode is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.

ErrorDescription

Data type: string
Access type: Read-only

A string that provides more information about the error recorded in LastErrorCode and information about any corrective actions that can be taken. 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 nonfunctional. This property is inherited from CIM_ManagedSystemElement.

Value	Meaning
5	OK

IdentifyingDescriptions

Data type: string array
Access type: Read-only

An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo property array. This property is inherited from CIM_LogicalDevice, and it is always set to Null.

InstallDate

Data type: datetime
Access type: Read-only

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

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

LastErrorCode

Data type: uint32
Access type: Read-only

The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

MaxMemorySupported

Data type: uint32
Access type: Read-only

The maximum amount of memory supported, in bytes. This property is inherited from CIM_DisplayController.

MaxNumberControlled

Data type: uint32
Access type: Read-only

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.

MaxQuiesceTime

Data type: uint64
Access type: Read-only

This property has been deprecated. This property is inherited from CIM_LogicalDevice.

Name

Data type: string
Access type: Read-only

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.

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.

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

OperationalStatus

Data type: uint16 array
Access type: Read-only

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

OtherEnabledState

Data type: string
Access type: Read-only

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

Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice, and it is always set to Null.

OtherVideoArchitecture

Data type: string
Access type: Read-only

A string that describes the video architecture type when the VideoArchitecture property is 1 ("Other"). This property is inherited from CIM_DisplayController.

OtherVideoMemoryType

Data type: string
Access type: Read-only

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

PowerManagementCapabilities

Data type: uint16 array
Access type: Read-only

The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerManagementSupported

Data type: boolean
Access type: Read-only

Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice, but it is not used.

PowerOnHours

Data type: uint64
Access type: Read-only

The number of consecutive hours that this device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice, but it is not used.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ProtocolDescription

Data type: string
Access type: Read-only

A string that provides more information that is related to the protocol supported by the controller. This property is inherited from CIM_Controller.

ProtocolSupported

Data type: uint16
Access type: Read-only

The protocol used by the controller to access controlled devices. This property is inherited from CIM_Controller.

RequestedState

Data type: uint16
Access type: Read-only

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. This property is inherited from CIM_EnabledLogicalElement.

Value	Meaning
12	Not Applicable

Status

Data type: string
Access type: Read-only

The current status of the object. This property is inherited from CIM_ManagedSystemElement, but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only

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

The current state of the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.

SystemCreationClassName

Data type: string
Access type: Read-only

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

SystemName

Data type: string
Access type: Read-only

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

TimeOfLastReset

Data type: datetime
Access type: Read-only

The last time the virtual machine 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

The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

VideoArchitecture

Data type: uint16
Access type: Read-only

Specifies the display controller's video architecture used to generate the video signal. Usually, a dedicated video processor generates the video signal in accordance with the specified architecture. It is an indicator of the maximum resolution capability of the display controller. This property is inherited from CIM_DisplayController.

Unknown (0)
Other (1)
CGA (2)
EGA (3)
VGA (4)
SVGA (5)
MDA (6)
HGC (7)
MCGA (8)
8514A (9)
XGA (10)
Linear Frame Buffer (11)
PC-98 (160)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

VideoMemoryType

Data type: uint16
Access type: Read-only

The type of video memory. This property is inherited from CIM_DisplayController.

VideoProcessor

Data type: string
Access type: Read-only

A string that describes the video processor/controller. This property is inherited from CIM_DisplayController.

Remarks

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

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

Share via