IVMGuestOS interface

[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]

Defines the guest operating system running inside a virtual machine. This interface allows you to interact with the integration components running inside the guest operating system. The IVMGuestOS for a virtual machine can be retrieved using the IVMVirtualMachine::GuestOS property.

Members

The IVMGuestOS interface inherits from the IDispatch interface. IVMGuestOS also has these types of members:

• Methods
• Properties

Methods

The IVMGuestOS interface has these methods.

Method	Description
GetOsVersionInfo	Retrieves version information for the guest operating system running in the virtual machine.
GetParameter	Retrieves a named parameter within the guest.
InstallIntegrationComponents	Locates and installs the latest Integration Components into the guest operating system.
IsUserLoggedOn	Determines whether the requested session is present.
Logoff	Logs off all users from the guest operating system.
Restart	Restarts the guest operating system.
SetParameter	Sets a named parameter within the guest.
Shutdown	Shuts down the guest operating system.

Properties

The IVMGuestOS interface has these properties.

Property	Access type	Description
CanShutdown	Read-only	Indicates whether the guest operating system can be cleanly shut down (requires Integration Components).
ComputerName	Read-only	The computer name of the guest operating system running in the virtual machine.
CSDVersion	Read-only	The CSDVersion of the guest operating system running in the virtual machine.
HeartbeatPercentage	Read-only	The percentage of expected heartbeats received over the past minute.
IntegrationComponentsVersion	Read-only	The version of the Integration Components installed in the guest operating system.
IsHeartbeating	Read-only	Indicates whether the virtual machine has a heartbeat.
IsHostTimeSyncEnabled	Read/write	Indicates whether the Integration Components in this virtual machine should synchronize the guest's clock with the host's clock.
MultipleUserSessionsAllowed	Read-only	Indicates whether multiple simultaneous user sessions are allowed in the guest operating system.
OSBuildNumber	Read-only	The build number of the guest operating system running in the virtual machine.
OSMajorVersion	Read-only	The major version of the guest operating system running in the virtual machine.
OSMinorVersion	Read-only	The minor version of the guest operating system running in the virtual machine.
OSName	Read-only	The name of the guest operating system running in the virtual machine.
OSPlatformId	Read-only	The platform identifier of the guest operating system running in the virtual machine.
OSVersion	Read-only	The version of the guest operating system running in the virtual machine.
ProductType	Read-only	The product type of the guest operating system running in the virtual machine.
ScreenLocked	Read-only	Indicates whether the screen is locked in the guest operating system.
ServicePackMajor	Read-only	The major version of the service pack of the guest operating system running in the virtual machine.
ServicePackMinor	Read-only	The minor version of the service pack of the guest operating system running in the virtual machine.
SuiteMask	Read-only	The SuiteMask of the guest operating system running in the virtual machine.
TerminalServerPort	Read-only	Port used by Remote Desktop Services in the guest operating system.
TerminalServicesInitialized	Read-only	The status of Terminal Services initialization in the guest operating system.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	None supported
End of client support	Windows 7
Product	Windows Virtual PC
Header	VPCCOMInterfaces.h
IID	IID_IVMGuestOS is defined as 99fea0db-4880-499a-b6d8-73dff9bc91be