Share via

Msvm_VideoHead class

  • Article

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   Caption = "Video Head";
  string   Description = "Microsoft Virtual Video Head";
  string   ElementName = "Video Head";
  datetime InstallDate;
  string   Name = "Video Head";
  uint16   OperationalStatus[] = 2;
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_VideoHead";
  string   DeviceID = "Microsoft:GUID\Head\Index";
  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;
  uint16   LocationIndicator = 4;
  uint32   CurrentBitsPerPixel;
  uint32   CurrentHorizontalResolution;
  uint32   CurrentVerticalResolution;
  uint32   MaxRefreshRate;
  uint32   MinRefreshRate;
  uint32   CurrentRefreshRate;
  uint16   CurrentScanMode;
  string   OtherCurrentScanMode;
  uint64   CurrentNumberOfColors;
  string   StatusDescriptions[] = { "OK" };
  uint32   CurrentNumberOfRows;
  uint32   CurrentNumberOfColumns;
};

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 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_VideoHead class has these properties.

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 6 (Not Applicable).

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 "Video Head".

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

CurrentBitsPerPixel

Data type: uint32

Access type: Read-only

Qualifiers: Units ("Bits"), MappingStrings ("MIF.DMTF|Video|004.12")

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"), MappingStrings ("MIF.DMTF|Video|004.11"), ModelCorrespondence ("CIM_VideoHeadResolution.HorizontalResolution")

The current number of horizontal pixels. This property is inherited from CIM_VideoHead.

CurrentNumberOfColors

Data type: uint64

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_VideoHeadResolution.NumberOfColors")

The number of colors supported at the current resolutions. This property is inherited from CIM_VideoHead.

CurrentNumberOfColumns

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Video|004.14")

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

Qualifiers: MappingStrings ("MIF.DMTF|Video|004.13")

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"), MappingStrings ("MIF.DMTF|Video|004.15"), ModelCorrespondence ("CIM_VideoHeadResolution.RefreshRate")

The current refresh rate, in hertz. This property is inherited from CIM_VideoHead.

CurrentScanMode

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Video|004.8"), ModelCorrespondence ("CIM_VideoHead.OtherCurrentScanMode, CIM_VideoHeadResolution.ScanMode")

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"), MappingStrings ("MIF.DMTF|Video|004.10"), ModelCorrespondence ("CIM_VideoHeadResolution.VerticalResolution")

The current number of vertical pixels. This property is inherited from CIM_VideoHead.

Description

Data type: string

Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Virtual Video Head".

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\Head\Index".

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 "Video Head" 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 always set to 2 (Enabled).

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

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.

MaxRefreshRate

Data type: uint32

Access type: Read-only

Qualifiers: Units ("Hertz"), MappingStrings ("MIF.DMTF|Video|004.5"), ModelCorrespondence ("CIM_VideoHeadResolution.MaxRefreshRate")

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"), MappingStrings ("MIF.DMTF|Video|004.4"), ModelCorrespondence ("CIM_VideoHeadResolution.MinRefreshRate")

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

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.

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.

OtherCurrentScanMode

Data type: string

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_VideoHead.CurrentScanMode, CIM_VideoHeadResolution.OtherScanMode")

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

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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

Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")

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

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 inherited from CIM_EnabledLogicalElement and it is always set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

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.

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

Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter

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

Remarks

Access to the Msvm_VideoHead 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

See also

CIM_VideoHead

CIM_VideoHead

Video Classes