Describes the primary drawing surface on a display controller.
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_VideoHead : CIM_VideoHead
{
string InstanceID;
string Caption = "Video Head";
string Description = "Microsoft Virtual Video Head";
string ElementName = "Video Head";
datetime InstallDate;
string Name = "Video Head";
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 = 12;
string SystemCreationClassName = "Msvm_ComputerSystem";
string SystemName;
uint16 CreationClassName = "Msvm_VideoHead";
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;
uint32 CurrentBitsPerPixel;
uint32 CurrentHorizontalResolution;
uint32 CurrentVerticalResolution;
uint32 MaxRefreshRate;
uint32 MinRefreshRate;
uint32 CurrentRefreshRate;
uint16 CurrentScanMode;
string OtherCurrentScanMode;
uint32 CurrentNumberOfRows;
uint32 CurrentNumberOfColumns;
uint64 CurrentNumberOfColors;
};
Members
The Msvm_VideoHead class has these types of members:
Methods
The Msvm_VideoHead 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_VideoHead class has these properties.
AdditionalAvailability
Data type: uint16 array
Access type: Read-only
Any additional availability and status of the device. This property is inherited from CIM_LogicalDevice, and it is set to 6 (Not Applicable).
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.
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.
CurrentBitsPerPixel
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Bits")
The number of bits used to display each pixel. This property is inherited from CIM_VideoHead.
CurrentHorizontalResolution
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Pixels")
The current number of horizontal pixels. This property is inherited from CIM_VideoHead.
CurrentNumberOfColors
Data type: uint64
Access type: Read-only
The number of colors supported at the current resolutions. This property is inherited from CIM_VideoHead.
CurrentNumberOfColumns
Data type: uint32
Access type: Read-only
If in character mode, the number of columns for this display controller. Otherwise, 0. This property is inherited from CIM_VideoHead.
CurrentNumberOfRows
Data type: uint32
Access type: Read-only
If in character mode, the number of rows for this video controller. Otherwise, 0. This property is inherited from CIM_VideoHead.
CurrentRefreshRate
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Hertz")
The current refresh rate, in hertz. This property is inherited from CIM_VideoHead.
CurrentScanMode
Data type: uint16
Access type: Read-only
The current scan mode. This property is inherited from CIM_VideoHead.
Unknown (0)
Other (1)
Not Supported (2)
Non-Interlaced Operation (3)
Interlaced Operation (4)
CurrentVerticalResolution
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Pixels")
The current number of vertical pixels. This property is inherited from CIM_VideoHead.
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
This property is inherited from CIM_LogicalDevice, and it is set to "Microsoft:GUID\Head\Index".
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, and it is always set to 2 (Enabled).
| 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.
| 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 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.
MaxQuiesceTime
Data type: uint64
Access type: Read-only
This property has been deprecated. This property is inherited from CIM_LogicalDevice.
MaxRefreshRate
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Hertz")
The maximum refresh rate of the display controller, in hertz. This property is inherited from CIM_VideoHead.
MinRefreshRate
Data type: uint32
Access type: Read-only
Qualifiers: Units ("Hertz")
The minimum refresh rate of the video controller, in hertz. This property is inherited from CIM_VideoHead.
Name
Data type: string
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is the same as the ElementName property.
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.
OtherCurrentScanMode
Data type: string
Access type: Read-only
The current scan mode when the instance's CurrentScanMode property is 1 (Other). This property is inherited from CIM_VideoHead and it is set to Null.
OtherEnabledState
Data type: string
Access type: Read-only
A string that describes 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 set to Null.
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.. )
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 inherited from CIM_EnabledLogicalElement.
| Value | Meaning |
|---|---|
| 12 | Not Applicable |
Status
Data type: string
Access type: Read-only
A string that specifies 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.
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.
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, and it is always set to Null.
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.
| Value | Meaning |
|---|---|
| 12 | Not Applicable |
Remarks
Access to the Msvm_VideoHead 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 |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
