org.virtualbox_7_1
Class IPlatformX86

java.lang.Object
  extended by org.virtualbox_7_1.IUnknown
      extended by org.virtualbox_7_1.IPlatformX86

public class IPlatformX86
extends IUnknown

The x86 specific platform properties for a virtual machine. Accessed viaIMachine.getPlatform()andIPlatform.getX86(). Interface ID: {5ADA589F-09C9-4604-B700-9AB3A5572E3A}


Field Summary
 
Fields inherited from class org.virtualbox_7_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IPlatformX86(java.lang.String wrapped, org.virtualbox_7_1.ObjectRefManager objMgr, org.virtualbox_7_1.jaxws.VboxPortType port)
           
 
Method Summary
 void getCPUIDLeaf(java.lang.Long idx, java.lang.Long idxSub, Holder<java.lang.Long> valEax, Holder<java.lang.Long> valEbx, Holder<java.lang.Long> valEcx, Holder<java.lang.Long> valEdx)
          Returns the virtual CPU cpuid information for the specified leaf.
 void getCPUIDLeafByOrdinal(java.lang.Long ordinal, Holder<java.lang.Long> idx, Holder<java.lang.Long> idxSub, Holder<java.lang.Long> valEax, Holder<java.lang.Long> valEbx, Holder<java.lang.Long> valEcx, Holder<java.lang.Long> valEdx)
          Used to enumerate CPUID information override values.
 java.lang.Boolean getCPUProperty(CPUPropertyTypeX86 property)
          Returns the virtual CPU boolean value of the specified property.
 java.lang.Boolean getHPETEnabled()
          This attribute controls if High Precision Event Timer (HPET) is enabled in this VM.
 java.lang.Boolean getHWVirtExProperty(HWVirtExPropertyType property)
          Returns the value of the specified hardware virtualization boolean property.
static IPlatformX86 queryInterface(IUnknown obj)
           
 void removeAllCPUIDLeaves()
          Removes all the virtual CPU cpuid leaves
 void removeCPUIDLeaf(java.lang.Long idx, java.lang.Long idxSub)
          Removes the virtual CPU cpuid leaf for the specified index
 void setCPUIDLeaf(java.lang.Long idx, java.lang.Long idxSub, java.lang.Long valEax, java.lang.Long valEbx, java.lang.Long valEcx, java.lang.Long valEdx)
          Sets the virtual CPU cpuid information for the specified leaf.
 void setCPUProperty(CPUPropertyTypeX86 property, java.lang.Boolean value)
          Sets the virtual CPU boolean value of the specified property.
 void setHPETEnabled(java.lang.Boolean value)
          This attribute controls if High Precision Event Timer (HPET) is enabled in this VM.
 void setHWVirtExProperty(HWVirtExPropertyType property, java.lang.Boolean value)
          Sets a new value for the specified hardware virtualization boolean property.
 
Methods inherited from class org.virtualbox_7_1.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IPlatformX86

public IPlatformX86(java.lang.String wrapped,
                    org.virtualbox_7_1.ObjectRefManager objMgr,
                    org.virtualbox_7_1.jaxws.VboxPortType port)
Method Detail

getHPETEnabled

public java.lang.Boolean getHPETEnabled()
This attribute controls if High Precision Event Timer (HPET) is enabled in this VM. Use this property if you want to provide guests with additional time source, or if guest requires HPET to function correctly. Default is false.

Returns:
Boolean

setHPETEnabled

public void setHPETEnabled(java.lang.Boolean value)
This attribute controls if High Precision Event Timer (HPET) is enabled in this VM. Use this property if you want to provide guests with additional time source, or if guest requires HPET to function correctly. Default is false.

Parameters:
value - Boolean

queryInterface

public static IPlatformX86 queryInterface(IUnknown obj)

getCPUProperty

public java.lang.Boolean getCPUProperty(CPUPropertyTypeX86 property)
Returns the virtual CPU boolean value of the specified property.

Expected result codes:
E_INVALIDARG - Invalid property.

Parameters:
property - Property type to query.
Returns:
Property value.

setCPUProperty

public void setCPUProperty(CPUPropertyTypeX86 property,
                           java.lang.Boolean value)
Sets the virtual CPU boolean value of the specified property.

Expected result codes:
E_INVALIDARG - Invalid property.

Parameters:
property - Property type to query.
value - Property value.

getCPUIDLeafByOrdinal

public void getCPUIDLeafByOrdinal(java.lang.Long ordinal,
                                  Holder<java.lang.Long> idx,
                                  Holder<java.lang.Long> idxSub,
                                  Holder<java.lang.Long> valEax,
                                  Holder<java.lang.Long> valEbx,
                                  Holder<java.lang.Long> valEcx,
                                  Holder<java.lang.Long> valEdx)
Used to enumerate CPUID information override values.

Expected result codes:
E_INVALIDARG - Invalid ordinal number is out of range.

Parameters:
ordinal - The ordinal number of the leaf to get.
idx - CPUID leaf index.
idxSub - CPUID leaf sub-index.
valEax - CPUID leaf value for register eax.
valEbx - CPUID leaf value for register ebx.
valEcx - CPUID leaf value for register ecx.
valEdx - CPUID leaf value for register edx.

getCPUIDLeaf

public void getCPUIDLeaf(java.lang.Long idx,
                         java.lang.Long idxSub,
                         Holder<java.lang.Long> valEax,
                         Holder<java.lang.Long> valEbx,
                         Holder<java.lang.Long> valEcx,
                         Holder<java.lang.Long> valEdx)
Returns the virtual CPU cpuid information for the specified leaf. Currently supported index values for cpuid: Standard CPUID leaves: 0 - 0x1f Extended CPUID leaves: 0x80000000 - 0x8000001f VIA CPUID leaves: 0xc0000000 - 0xc000000f See the Intel, AMD and VIA programmer's manuals for detailed information about the CPUID instruction and its leaves.

Expected result codes:
E_INVALIDARG - Invalid index.

Parameters:
idx - CPUID leaf index.
idxSub - CPUID leaf sub-index (ECX). Set to 0xffffffff (or 0) if not applicable.
valEax - CPUID leaf value for register eax.
valEbx - CPUID leaf value for register ebx.
valEcx - CPUID leaf value for register ecx.
valEdx - CPUID leaf value for register edx.

setCPUIDLeaf

public void setCPUIDLeaf(java.lang.Long idx,
                         java.lang.Long idxSub,
                         java.lang.Long valEax,
                         java.lang.Long valEbx,
                         java.lang.Long valEcx,
                         java.lang.Long valEdx)
Sets the virtual CPU cpuid information for the specified leaf. Note that these values are not passed unmodified. VirtualBox clears features that it doesn't support. Currently supported index values for cpuid: Standard CPUID leaves: 0 - 0x1f Extended CPUID leaves: 0x80000000 - 0x8000001f VIA CPUID leaves: 0xc0000000 - 0xc000000f The subleaf index is only applicable to certain leaves (see manuals as this is subject to change). See the Intel, AMD and VIA programmer's manuals for detailed information about the cpuid instruction and its leaves. Do not use this method unless you know exactly what you're doing. Misuse can lead to random crashes inside VMs.

Expected result codes:
E_INVALIDARG - Invalid index.

Parameters:
idx - CPUID leaf index.
idxSub - CPUID leaf sub-index (ECX). Set to 0xffffffff (or 0) if not applicable. The 0xffffffff causes it to remove all other subleaves before adding one with sub-index 0.
valEax - CPUID leaf value for register eax.
valEbx - CPUID leaf value for register ebx.
valEcx - CPUID leaf value for register ecx.
valEdx - CPUID leaf value for register edx.

removeCPUIDLeaf

public void removeCPUIDLeaf(java.lang.Long idx,
                            java.lang.Long idxSub)
Removes the virtual CPU cpuid leaf for the specified index

Expected result codes:
E_INVALIDARG - Invalid index.

Parameters:
idx - CPUID leaf index.
idxSub - CPUID leaf sub-index (ECX). Set to 0xffffffff (or 0) if not applicable. The 0xffffffff value works like a wildcard.

removeAllCPUIDLeaves

public void removeAllCPUIDLeaves()
Removes all the virtual CPU cpuid leaves


getHWVirtExProperty

public java.lang.Boolean getHWVirtExProperty(HWVirtExPropertyType property)
Returns the value of the specified hardware virtualization boolean property.

Expected result codes:
E_INVALIDARG - Invalid property.

Parameters:
property - Property type to query.
Returns:
Property value.

setHWVirtExProperty

public void setHWVirtExProperty(HWVirtExPropertyType property,
                                java.lang.Boolean value)
Sets a new value for the specified hardware virtualization boolean property.

Expected result codes:
E_INVALIDARG - Invalid property.

Parameters:
property - Property type to set.
value - New property value.