Share via

IVMGuestOS::OSName property

The OSName property contains the name of the guest operating system running in the virtual machine.

This property is read-only.

Syntax

HRESULT get_OSName(
  [out] BSTR *guestOSName
);

VB 
VMGuestOS.OSName( _
  ByRef guestOSName _
)

Property value

The full name (including suite name) of the guest operating system.

This property value is read-only.

Error codes

Name Meaning
S_OK
 The operation was successful.
E_POINTER
 guestOSName was not specified.
VM_E_VM_NOT_RUNNING
 The virtual machine is not running.
VM_E_ADDITIONS_FEATURE_NOT_AVAIL
 The virtual machine is not fully booted or Additions are not installed.
DISP_E_EXCEPTION
 An unexpected error occurred.

Remarks

The virtual machine must be running (that is, fully booted and not shutting down) and Additions must be installed when this method is invoked.

The following is a list of the possible names returned by the various Microsoft operating systems:

  • Windows Server 2003
  • Windows Server 2003, Standard Edition
  • Windows Server 2003, Enterprise Edition
  • Windows Server 2003, Datacenter Edition
  • Windows Server 2003, Web Edition
  • Windows Advanced Server, Limited Edition
  • Windows XP Home Edition
  • Windows XP Professional
  • Windows XP Embedded
  • Windows XP 64-Bit Edition
  • Windows XP Media Center Edition
  • Windows XP Tablet PC Edition
  • Windows XP 64-Bit Edition Version 2003
  • Windows 2000
  • Windows 2000 Professional
  • Windows 2000 Server
  • Windows 2000 Advanced Server
  • Windows 2000 Datacenter Server

Requirements
Product
 Microsoft Virtual Server 2005 onWindows Server 2003
Download
 Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header
VsComInterfaces.h

See also

IVMGuestOS