Changeset 34416 in vbox for trunk/src/VBox
- Timestamp:
- Nov 26, 2010 5:17:12 PM (14 years ago)
- Location:
- trunk/src/VBox/Main
- Files:
-
- 3 edited
- 1 copied
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/Makefile.kmk
r34397 r34416 630 630 VirtualBoxBase.cpp \ 631 631 VirtualBoxErrorInfoImpl.cpp \ 632 VirtualBoxClientImpl.cpp \ 632 633 ProgressImpl.cpp \ 633 634 SharedFolderImpl.cpp \ -
trunk/src/VBox/Main/idl/VirtualBox.xidl
r34398 r34416 129 129 #ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI 130 130 # define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \ 131 NS_IMPL_THREADSAFE_ADDREF(_class)\132 NS_IMPL_THREADSAFE_RELEASE(_class)\133 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface)\134 131 NS_IMPL_THREADSAFE_ADDREF(_class) \ 132 NS_IMPL_THREADSAFE_RELEASE(_class) \ 133 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \ 134 NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface) 135 135 #endif 136 136 137 137 #ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI 138 138 # define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \ 139 NS_IMPL_THREADSAFE_ADDREF(_class)\140 NS_IMPL_THREADSAFE_RELEASE(_class)\141 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2)\142 139 NS_IMPL_THREADSAFE_ADDREF(_class) \ 140 NS_IMPL_THREADSAFE_RELEASE(_class) \ 141 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \ 142 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2) 143 143 #endif 144 144 145 145 #ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI 146 146 # define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \ 147 NS_IMPL_THREADSAFE_ADDREF(_class)\148 NS_IMPL_THREADSAFE_RELEASE(_class)\149 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3)\150 147 NS_IMPL_THREADSAFE_ADDREF(_class) \ 148 NS_IMPL_THREADSAFE_RELEASE(_class) \ 149 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \ 150 NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3) 151 151 #endif 152 152 153 153 #ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI 154 154 # define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \ 155 NS_IMPL_THREADSAFE_ADDREF(_class)\156 NS_IMPL_THREADSAFE_RELEASE(_class)\157 NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4)\158 155 NS_IMPL_THREADSAFE_ADDREF(_class) \ 156 NS_IMPL_THREADSAFE_RELEASE(_class) \ 157 NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \ 158 NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4) 159 159 #endif 160 160 161 161 #ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI 162 162 # define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \ 163 NS_INTERFACE_MAP_BEGIN(_class)\163 NS_INTERFACE_MAP_BEGIN(_class) \ 164 164 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \ 165 165 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \ 166 166 NS_IMPL_QUERY_CLASSINFO(_class) \ 167 167 NS_INTERFACE_MAP_END 168 168 #endif 169 169 … … 171 171 # define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \ 172 172 _i2, _ic2) \ 173 NS_INTERFACE_MAP_BEGIN(_class)\173 NS_INTERFACE_MAP_BEGIN(_class) \ 174 174 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \ 175 175 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \ 176 176 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \ 177 177 NS_IMPL_QUERY_CLASSINFO(_class) \ 178 178 NS_INTERFACE_MAP_END 179 179 #endif 180 180 … … 182 182 # define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \ 183 183 _i2, _ic2, _i3, _ic3) \ 184 NS_INTERFACE_MAP_BEGIN(_class)\184 NS_INTERFACE_MAP_BEGIN(_class) \ 185 185 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \ 186 186 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \ … … 188 188 NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \ 189 189 NS_IMPL_QUERY_CLASSINFO(_class) \ 190 190 NS_INTERFACE_MAP_END 191 191 #endif 192 192 … … 197 197 #ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI 198 198 # define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \ 199 NS_IMPL_THREADSAFE_ADDREF(_class)\200 NS_IMPL_THREADSAFE_RELEASE(_class)\201 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1)\202 199 NS_IMPL_THREADSAFE_ADDREF(_class) \ 200 NS_IMPL_THREADSAFE_RELEASE(_class) \ 201 NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \ 202 NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1) 203 203 #endif 204 204 … … 206 206 # define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \ 207 207 _i2, _ic2) \ 208 NS_IMPL_THREADSAFE_ADDREF(_class)\209 NS_IMPL_THREADSAFE_RELEASE(_class)\210 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1,\211 _i2, _ic2)\212 208 NS_IMPL_THREADSAFE_ADDREF(_class) \ 209 NS_IMPL_THREADSAFE_RELEASE(_class) \ 210 NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \ 211 _i2, _ic2) \ 212 NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2) 213 213 #endif 214 214 … … 216 216 # define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \ 217 217 _i2, _ic2, _i3, _ic3) \ 218 NS_IMPL_THREADSAFE_ADDREF(_class)\219 NS_IMPL_THREADSAFE_RELEASE(_class)\220 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1,\221 _i2, _ic2, _i3, _ic3)\222 218 NS_IMPL_THREADSAFE_ADDREF(_class) \ 219 NS_IMPL_THREADSAFE_RELEASE(_class) \ 220 NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \ 221 _i2, _ic2, _i3, _ic3) \ 222 NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3) 223 223 #endif 224 224 … … 227 227 228 228 <library 229 230 231 232 233 234 229 name="VirtualBox" 230 uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259" 231 version="1.3" 232 desc="VirtualBox Type Library" 233 appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9" 234 supportsErrorInfo="yes" 235 235 > 236 236 … … 385 385 --> 386 386 387 <enum name="SettingsVersion" 388 uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f" 387 <enum 388 name="SettingsVersion" 389 uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f" 389 390 > 390 <desc>Settings version of VirtualBox settings files. This is written to 391 the "version" attribute of the root "VirtualBox" element in the settings 392 file XML and indicates which VirtualBox version wrote the file. 391 <desc> 392 Settings version of VirtualBox settings files. This is written to 393 the "version" attribute of the root "VirtualBox" element in the settings 394 file XML and indicates which VirtualBox version wrote the file. 393 395 </desc> 394 396 … … 411 413 <desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc> 412 414 <!-- 413 415 Machine XML: Capitalization of Uart, Lpt elements and many attributes changed. 414 416 --> 415 417 </const> … … 423 425 <const name="v1_5" value="7"> 424 426 <desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc> 425 <!-- 2008-09-04: 2.0.0 released 426 2008-11-20: settings version 1.5 introduced 427 2008-12-17: 2.1.0 released 428 Machine changes: 429 guest OS identifiers changed; 430 Machine/Hardware/Display/MonitorCount renamed to monitorCount; 431 Machine/Hardware/Display/Accelerate3D renamed to accelerate3D; 432 Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count 427 <!-- 428 2008-09-04: 2.0.0 released 429 2008-11-20: settings version 1.5 introduced 430 2008-12-17: 2.1.0 released 431 Machine changes: 432 guest OS identifiers changed; 433 Machine/Hardware/Display/MonitorCount renamed to monitorCount; 434 Machine/Hardware/Display/Accelerate3D renamed to accelerate3D; 435 Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count 433 436 --> 434 437 </const> 435 438 <const name="v1_6" value="8"> 436 439 <desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc> 437 <!-- 2008-12-17: 2.1.0 released 438 2008-12-19: settings version 1.6 introduced (is in 2.1 branch) 439 2009-04-08: 2.2.0 released 440 Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done) 440 <!-- 441 2008-12-17: 2.1.0 released 442 2008-12-19: settings version 1.6 introduced (is in 2.1 branch) 443 2009-04-08: 2.2.0 released 444 Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done) 441 445 --> 442 446 </const> 443 447 <const name="v1_7" value="9"> 444 448 <desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc> 445 <!-- 2008-12-17: 2.1.0 released 446 2009-03-11: settings version 1.7 introduced (is in 2.2 branch) 447 2009-04-08: 2.2.0 released 448 VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done) 449 Machine changes: HardDiskAttachments is now StorageControllers (done) 449 <!-- 450 2008-12-17: 2.1.0 released 451 2009-03-11: settings version 1.7 introduced (is in 2.2 branch) 452 2009-04-08: 2.2.0 released 453 VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done) 454 Machine changes: HardDiskAttachments is now StorageControllers (done) 450 455 --> 451 456 </const> 452 457 <const name="v1_8" value="10"> 453 458 <desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc> 454 <!-- Machine additions: Display/@accelerate2DVideo (done) 459 <!-- 460 Machine additions: Display/@accelerate2DVideo (done) 455 461 --> 456 462 </const> 457 463 <const name="v1_9" value="11"> 458 464 <desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc> 459 <!-- The big storage controller / DVD / Floppy rework (done) 460 --> 465 <!-- 466 The big storage controller / DVD / Floppy rework (done) 467 --> 461 468 </const> 462 469 <const name="v1_10" value="12"> 463 470 <desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc> 464 <!-- Machine changes: RTC localOrUTC (done) 465 CPU hot-plug support 466 --> 471 <!-- 472 Machine changes: RTC localOrUTC (done) 473 CPU hot-plug support 474 --> 467 475 </const> 468 476 <const name="v1_11" value="13"> 469 477 <desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc> 470 <!-- Machine changes: HD Audio controller, per-machine disk registries, 471 /@format attribute for DVD and floppy images. 472 --> 478 <!-- 479 Machine changes: HD Audio controller, per-machine disk registries, 480 /@format attribute for DVD and floppy images. 481 --> 473 482 </const> 474 483 <const name="Future" value="99999"> … … 478 487 479 488 <enum 480 481 482 483 484 485 486 487 488 489 name="AccessMode" 490 uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f" 491 > 492 <desc> 493 Access mode for opening files. 494 </desc> 495 496 <const name="ReadOnly" value="1"/> 497 <const name="ReadWrite" value="2"/> 489 498 </enum> 490 499 … … 492 501 name="MachineState" 493 502 uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe" 494 >503 > 495 504 <desc> 496 505 Virtual machine execution state. … … 796 805 name="SessionState" 797 806 uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8" 798 >807 > 799 808 <desc> 800 809 Session state. This enumeration represents possible values of … … 845 854 name="CPUPropertyType" 846 855 uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5" 847 >856 > 848 857 <desc> 849 858 Virtual CPU property type. This enumeration represents possible values of the … … 872 881 name="HWVirtExPropertyType" 873 882 uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee" 874 >883 > 875 884 <desc> 876 885 Hardware virtualization property type. This enumeration represents possible values … … 918 927 919 928 <enum 920 name="FaultToleranceState"921 uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"922 >929 name="FaultToleranceState" 930 uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1" 931 > 923 932 <desc> 924 933 Used with <link to="IMachine::faultToleranceState" />. … … 936 945 937 946 <enum 938 name="LockType"939 uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"940 >947 name="LockType" 948 uuid="138b53f8-db4b-47c5-b32b-4ef52f769413" 949 > 941 950 <desc> 942 951 Used with <link to="IMachine::lockMachine" />. … … 953 962 name="SessionType" 954 963 uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A" 955 >964 > 956 965 <desc> 957 966 Session type. This enumeration represents possible values of the … … 985 994 name="DeviceType" 986 995 uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57" 987 >996 > 988 997 <desc> 989 998 Device type. … … 1018 1027 name="DeviceActivity" 1019 1028 uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707" 1020 >1029 > 1021 1030 <desc> 1022 1031 Device activity for <link to="IConsole::getDeviceActivity"/>. … … 1032 1041 name="ClipboardMode" 1033 1042 uuid="33364716-4008-4701-8f14-be0fa3d62950" 1034 >1043 > 1035 1044 <desc> 1036 Host-Guest clipboard interchange mode.1045 Host-Guest clipboard interchange mode. 1037 1046 </desc> 1038 1047 … … 1046 1055 name="Scope" 1047 1056 uuid="7c91096e-499e-4eca-9f9b-9001438d7855" 1048 >1057 > 1049 1058 <desc> 1050 1059 Scope of the operation. … … 1062 1071 name="BIOSBootMenuMode" 1063 1072 uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5" 1064 >1073 > 1065 1074 <desc> 1066 1075 BIOS boot menu mode. … … 1075 1084 name="ProcessorFeature" 1076 1085 uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf" 1077 >1086 > 1078 1087 <desc> 1079 1088 CPU features. … … 1086 1095 </enum> 1087 1096 1088 1097 <enum 1089 1098 name="FirmwareType" 1090 1099 uuid="b903f264-c230-483e-ac74-2b37ce60d371" 1091 >1100 > 1092 1101 <desc> 1093 1102 Firmware type. … … 1110 1119 </enum> 1111 1120 1112 1121 <enum 1113 1122 name="PointingHidType" 1114 1123 uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97" 1115 >1124 > 1116 1125 <desc> 1117 1126 Type of pointing device used in a virtual machine. … … 1135 1144 </enum> 1136 1145 1137 1146 <enum 1138 1147 name="KeyboardHidType" 1139 1148 uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc" 1140 >1149 > 1141 1150 <desc> 1142 1151 Type of keyboard device used in a virtual machine. … … 1163 1172 1164 1173 <interface 1165 1166 1167 1168 1169 1174 name="IVirtualBoxErrorInfo" extends="$errorinfo" 1175 uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4" 1176 supportsErrorInfo="no" 1177 wsmap="managed" 1178 > 1170 1179 <desc> 1171 1180 The IVirtualBoxErrorInfo interface represents extended error information. … … 1266 1275 uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3" 1267 1276 wsmap="managed" 1268 >1277 > 1269 1278 <desc> 1270 1279 The IDHCPServer interface represents the vbox dhcp server configuration. … … 1377 1386 uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff" 1378 1387 wsmap="managed" 1379 >1388 > 1380 1389 <desc> 1381 1390 The IVirtualBox interface represents the main interface exposed by the … … 2192 2201 name="VFSType" 2193 2202 uuid="813999ba-b949-48a8-9230-aadc6285e2f2" 2194 >2203 > 2195 2204 <desc> 2196 2205 Virtual file systems supported by VFSExplorer. … … 2206 2215 name="VFSFileType" 2207 2216 uuid="714333cd-44e2-415f-a245-d378fa9b1242" 2208 >2217 > 2209 2218 <desc> 2210 2219 File types known by VFSExplorer. … … 2223 2232 2224 2233 <interface 2225 2226 2227 2228 2234 name="IVFSExplorer" extends="$unknown" 2235 uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f" 2236 wsmap="managed" 2237 > 2229 2238 <desc> 2230 2239 The VFSExplorer interface unifies access to different file system … … 2327 2336 2328 2337 <interface 2329 2330 2331 2332 2338 name="IAppliance" extends="$unknown" 2339 uuid="7b148032-4124-4f46-b56a-b48ac1273f5a" 2340 wsmap="managed" 2341 > 2333 2342 <desc> 2334 2343 Represents a platform-independent appliance in OVF format. An instance of this is returned … … 2588 2597 name="VirtualSystemDescriptionType" 2589 2598 uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90" 2590 >2599 > 2591 2600 <desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of 2592 2601 a configuration value.</desc> … … 2621 2630 name="VirtualSystemDescriptionValueType" 2622 2631 uuid="56d9403f-3425-4118-9919-36f2a9b8c77c" 2623 >2632 > 2624 2633 <desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value 2625 2634 type to fetch.</desc> … … 2633 2642 2634 2643 <interface 2635 2636 2637 2638 2644 name="IVirtualSystemDescription" extends="$unknown" 2645 uuid="d7525e6c-531a-4c51-8e04-41235083a3d8" 2646 wsmap="managed" 2647 > 2639 2648 2640 2649 <desc>Represents one virtual system (machine) in an appliance. This interface is used in … … 2739 2748 </li> 2740 2749 <li> 2741 2742 2750 "CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same 2751 attachment information as with "HardDiskImage" items. 2743 2752 </li> 2744 2753 <li> … … 2897 2906 2898 2907 <interface 2899 2900 2901 2902 2903 2908 name="IInternalMachineControl" extends="$unknown" 2909 uuid="476126af-e223-4490-a8a0-b1f1575be013" 2910 internal="yes" 2911 wsmap="suppress" 2912 > 2904 2913 <method name="setRemoveSavedStateFile"> 2905 2914 <desc> … … 3293 3302 3294 3303 <interface 3295 3296 3297 3298 3304 name="IBIOSSettings" extends="$unknown" 3305 uuid="38b54279-dc35-4f5e-a431-835b867c6b5e" 3306 wsmap="managed" 3307 > 3299 3308 <desc> 3300 3309 The IBIOSSettings interface represents BIOS settings of the virtual … … 3354 3363 </interface> 3355 3364 3356 <enum name="CleanupMode" 3357 uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"> 3365 <enum 3366 name="CleanupMode" 3367 uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441" 3368 > 3358 3369 <desc>Cleanup mode, used with <link to="IMachine::unregister" />. 3359 3370 </desc> … … 3373 3384 3374 3385 <interface 3375 3376 3377 3378 3386 name="IEventContext" extends="$unknown" 3387 uuid="7563F4E7-1583-40F7-B4C4-C9BA02CB0AE3" 3388 wsmap="managed" 3389 > 3379 3390 <desc> 3380 3391 Placeholder class for event contexts. … … 3384 3395 3385 3396 <interface 3386 3387 3388 3389 3397 name="IPciAddress" extends="$unknown" 3398 uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8" 3399 wsmap="struct" 3400 > 3390 3401 3391 3402 <desc> … … 3426 3437 </interface> 3427 3438 3428 3429 3430 3431 3432 3439 <interface 3440 name="IPciDeviceAttachment" extends="$unknown" 3441 uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5" 3442 wsmap="struct" 3443 > 3433 3444 3434 3445 <desc> … … 3464 3475 3465 3476 <interface 3466 3467 3468 3469 3477 name="IMachine" extends="$unknown" 3478 uuid="711cbb73-75af-463c-af17-8b7860c01fe8" 3479 wsmap="managed" 3480 > 3470 3481 <desc> 3471 3482 The IMachine interface represents a virtual machine, or guest, created … … 3658 3669 3659 3670 <attribute name="CPUExecutionCap" type="unsigned long"> 3660 3661 3662 3663 3664 3671 <desc> 3672 Means to limit the number of CPU cycles a guest can use. The unit 3673 is percentage of host CPU cycles per second. The valid range 3674 is 1 - 100. 100 (the default) implies no limit. 3675 </desc> 3665 3676 </attribute> 3666 3677 … … 3712 3723 <attribute name="firmwareType" type="FirmwareType"> 3713 3724 <desc>Type of firmware (such as legacy BIOS or EFI), used for initial 3714 bootstrap in this VM.</desc>3725 bootstrap in this VM.</desc> 3715 3726 </attribute> 3716 3727 … … 4759 4770 </method> 4760 4771 4761 <method name="removeStorageController">4772 <method name="removeStorageController"> 4762 4773 <desc> 4763 4774 Removes a storage controller from the machine. … … 5845 5856 5846 5857 <interface 5847 5848 5849 5850 5851 5852 5853 5854 5858 name="IVRDEServerInfo" extends="$unknown" 5859 uuid="714434a1-58c3-4aab-9049-7652c5df113b" 5860 wsmap="struct" 5861 > 5862 <desc> 5863 Contains information about the remote desktop (VRDE) server capabilities and status. 5864 This is used in the <link to="IConsole::VRDEServerInfo" /> attribute. 5865 </desc> 5855 5866 5856 5867 <attribute name="active" type="boolean" readonly="yes"> … … 5953 5964 5954 5965 <interface 5955 5956 5957 5958 5966 name="IConsole" extends="$unknown" 5967 uuid="515e8e8d-f932-4d8e-9f32-79a52aead882" 5968 wsmap="managed" 5969 > 5959 5970 <desc> 5960 5971 The IConsole interface represents an interface to control virtual … … 6695 6706 name="HostNetworkInterfaceMediumType" 6696 6707 uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b" 6697 >6708 > 6698 6709 <desc> 6699 6710 Type of encapsulation. Ethernet encapsulation includes both wired and … … 6727 6738 name="HostNetworkInterfaceStatus" 6728 6739 uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41" 6729 >6740 > 6730 6741 <desc> 6731 6742 Current status of the interface. … … 6753 6764 name="HostNetworkInterfaceType" 6754 6765 uuid="67431b00-9946-48a2-bc02-b25c5919f4f3" 6755 >6766 > 6756 6767 <desc> 6757 6768 Network interface type. … … 6762 6773 6763 6774 <interface 6764 6765 6766 6767 6775 name="IHostNetworkInterface" extends="$unknown" 6776 uuid="ce6fae58-7642-4102-b5db-c9005c2320a8" 6777 wsmap="managed" 6778 > 6768 6779 <desc> 6769 6780 Represents one of host's network interfaces. IP V6 address and network … … 6863 6874 6864 6875 <interface 6865 6866 6867 6868 6876 name="IHost" extends="$unknown" 6877 uuid="35b004f4-7806-4009-bfa8-d1308adba7e5" 6878 wsmap="managed" 6879 > 6869 6880 <desc> 6870 6881 The IHost interface represents the physical machine that this VirtualBox … … 7306 7317 7307 7318 <interface 7308 7309 7310 7311 7312 7319 name="ISystemProperties" 7320 extends="$unknown" 7321 uuid="51c81048-b261-4fa2-a44e-fd756f0db589" 7322 wsmap="managed" 7323 > 7313 7324 <desc> 7314 7325 The ISystemProperties interface represents global properties of the given … … 7559 7570 <desc> 7560 7571 This value specifies how many old release log files are kept. 7561 7572 </desc> 7562 7573 </attribute> 7563 7574 … … 7661 7672 uuid="432c1546-1354-4abf-bf08-878a32a373f5" 7662 7673 wsmap="struct" 7663 >7674 > 7664 7675 <desc> 7665 7676 </desc> … … 7737 7748 </attribute> 7738 7749 7739 7750 <attribute name="recommendedHpet" type="boolean" readonly="yes"> 7740 7751 <desc>Returns @c true if using HPET is recommended for this OS type.</desc> 7741 7752 </attribute> … … 7749 7760 </attribute> 7750 7761 7751 7762 <attribute name="recommendedChipset" type="ChipsetType" readonly="yes"> 7752 7763 <desc>Recommended chipset type.</desc> 7753 7754 7755 7764 </attribute> 7765 7766 <attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes"> 7756 7767 <desc>Recommended audio type.</desc> 7757 7768 </attribute> 7758 7769 7759 7770 </interface> … … 7762 7773 name="AdditionsRunLevelType" 7763 7774 uuid="a25417ee-a9dd-4f5b-b0dc-377860087754" 7764 >7775 > 7765 7776 <desc> 7766 7777 Guest Additions run level type. … … 7801 7812 name="ExecuteProcessFlag" 7802 7813 uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0" 7803 >7814 > 7804 7815 <desc> 7805 7816 Guest process execution flags. … … 7823 7834 name="ProcessInputFlag" 7824 7835 uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5" 7825 >7836 > 7826 7837 <desc> 7827 7838 Guest process input flags. … … 7839 7850 name="CopyFileFlag" 7840 7851 uuid="23f79fdf-738a-493d-b80b-42d607c9b916" 7841 >7852 > 7842 7853 <desc> 7843 7854 Host/Guest copy flags. … … 7879 7890 7880 7891 <interface 7881 7882 7883 7884 7892 name="IGuest" extends="$unknown" 7893 uuid="1039b0cc-9bc1-4c6d-8d12-864aa48aa5b9" 7894 wsmap="managed" 7895 > 7885 7896 <desc> 7886 7897 The IGuest interface represents information about the operating system … … 7947 7958 <method name="internalGetStatistics"> 7948 7959 <desc> 7949 7960 Internal method; do not use as it might change at any time 7950 7961 </desc> 7951 7962 <param name="cpuUser" type="unsigned long" dir="out"> 7952 7963 <desc>Percentage of processor time spent in user mode as seen by the guest</desc> 7953 7964 </param> 7954 7965 <param name="cpuKernel" type="unsigned long" dir="out"> 7955 7966 <desc>Percentage of processor time spent in kernel mode as seen by the guest</desc> 7956 7967 </param> 7957 7968 <param name="cpuIdle" type="unsigned long" dir="out"> 7958 7969 <desc>Percentage of processor time spent idling as seen by the guest</desc> 7959 7970 </param> 7960 7971 <param name="memTotal" type="unsigned long" dir="out"> 7961 7972 <desc>Total amount of physical guest RAM</desc> 7962 7973 </param> 7963 7974 <param name="memFree" type="unsigned long" dir="out"> 7964 7975 <desc>Free amount of physical guest RAM</desc> 7965 7976 </param> 7966 7977 <param name="memBalloon" type="unsigned long" dir="out"> 7967 7978 <desc>Amount of ballooned physical guest RAM</desc> 7968 7979 </param> 7969 7980 <param name="memShared" type="unsigned long" dir="out"> … … 7971 7982 </param> 7972 7983 <param name="memCache" type="unsigned long" dir="out"> 7973 7984 <desc>Total amount of guest (disk) cache memory</desc> 7974 7985 </param> 7975 7986 <param name="pagedTotal" type="unsigned long" dir="out"> 7976 7987 <desc>Total amount of space in the page file</desc> 7977 7988 </param> 7978 7989 <param name="memAllocTotal" type="unsigned long" dir="out"> 7979 7990 <desc>Total amount of memory allocated by the hypervisor</desc> 7980 7991 </param> 7981 7992 <param name="memFreeTotal" type="unsigned long" dir="out"> 7982 7993 <desc>Total amount of free memory available in the hypervisor</desc> 7983 7994 </param> 7984 7995 <param name="memBalloonTotal" type="unsigned long" dir="out"> 7985 7996 <desc>Total amount of memory ballooned by the hypervisor</desc> 7986 7997 </param> 7987 7998 <param name="memSharedTotal" type="unsigned long" dir="out"> … … 8317 8328 8318 8329 <interface 8319 8320 8321 8322 8330 name="IProgress" extends="$unknown" 8331 uuid="A163C98F-8635-4AA8-B770-A9941737F3EF" 8332 wsmap="managed" 8333 > 8323 8334 <desc> 8324 8335 The IProgress interface is used to track and control … … 8536 8547 8537 8548 <interface 8538 8539 8540 8541 8549 name="ISnapshot" extends="$unknown" 8550 uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc" 8551 wsmap="managed" 8552 > 8542 8553 <desc> 8543 8554 The ISnapshot interface represents a snapshot of the virtual … … 8682 8693 name="MediumState" 8683 8694 uuid="ef41e980-e012-43cd-9dea-479d4ef14d13" 8684 >8695 > 8685 8696 <desc> 8686 8697 Virtual medium state. … … 8736 8747 name="MediumType" 8737 8748 uuid="19388a99-8e70-4bd4-9a95-90cbc513ef6d" 8738 >8749 > 8739 8750 <desc> 8740 8751 Virtual medium type. … … 8777 8788 name="MediumVariant" 8778 8789 uuid="584ea502-143b-4ab0-ad14-d1028fdf0316" 8779 >8790 > 8780 8791 <desc> 8781 8792 Virtual medium image variant. More than one flag may be set. … … 8820 8831 uuid="c29452cc-ca72-404b-9261-cfc514f1e412" 8821 8832 wsmap="struct" 8822 >8833 > 8823 8834 <desc> 8824 8835 The IMediumAttachment interface links storage media to virtual machines. … … 8873 8884 <attribute name="bandwidthLimit" type="unsigned long"> 8874 8885 <desc> 8875 8876 8886 Maximum throughput allowed for this medium attachment, in units of 1 mbps. 8887 A zero value means uncapped/unlimited. 8877 8888 </desc> 8878 8889 </attribute> … … 8884 8895 uuid="bfcf5b8c-5155-4f24-9414-9457054b16db" 8885 8896 wsmap="managed" 8886 >8897 > 8887 8898 <desc> 8888 8899 The IMedium interface represents virtual storage for a machine's … … 10284 10295 name="DataType" 10285 10296 uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7" 10286 >10297 > 10287 10298 <const name="Int32" value="0"/> 10288 10299 <const name="Int8" value="1"/> … … 10293 10304 name="DataFlags" 10294 10305 uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60" 10295 >10306 > 10296 10307 <const name="None" value="0x00"/> 10297 10308 <const name="Mandatory" value="0x01"/> … … 10304 10315 name="MediumFormatCapabilities" 10305 10316 uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd" 10306 >10317 > 10307 10318 <desc> 10308 10319 Medium format capability flags. 10309 10320 </desc> 10310 10321 … … 10380 10391 10381 10392 <interface 10382 10383 10384 10385 10393 name="IMediumFormat" extends="$unknown" 10394 uuid="4e9a873f-0599-434a-8345-619ef3fb3111" 10395 wsmap="managed" 10396 > 10386 10397 <desc> 10387 10398 The IMediumFormat interface represents a medium format. … … 10501 10512 10502 10513 <interface 10503 10504 10505 10506 10514 name="IKeyboard" extends="$unknown" 10515 uuid="f6916ec5-a881-4237-898f-7de58cf88672" 10516 wsmap="managed" 10517 > 10507 10518 <desc> 10508 10519 The IKeyboard interface represents the virtual machine's keyboard. Used … … 10565 10576 name="MouseButtonState" 10566 10577 uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8" 10567 >10578 > 10568 10579 <desc> 10569 10580 Mouse button state. … … 10581 10592 10582 10593 <interface 10583 10584 10585 10586 10594 name="IMouse" extends="$unknown" 10595 uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10" 10596 wsmap="managed" 10597 > 10587 10598 <desc> 10588 10599 The IMouse interface represents the virtual machine's mouse. Used in … … 10764 10775 name="FramebufferPixelFormat" 10765 10776 uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d" 10766 >10777 > 10767 10778 <desc> 10768 10779 Format of the video memory buffer. Constants represented by this enum can … … 10789 10800 10790 10801 <interface 10791 10792 10793 10794 10802 name="IFramebuffer" extends="$unknown" 10803 uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf" 10804 wsmap="suppress" 10805 > 10795 10806 <attribute name="address" type="octet" mod="ptr" readonly="yes"> 10796 10807 <desc>Address of the start byte of the frame buffer.</desc> … … 11118 11129 11119 11130 <interface 11120 11121 11122 11123 11131 name="IFramebufferOverlay" extends="IFramebuffer" 11132 uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47" 11133 wsmap="suppress" 11134 > 11124 11135 <desc> 11125 11136 The IFramebufferOverlay interface represents an alpha blended overlay … … 11164 11175 11165 11176 <interface 11166 11167 11168 11169 11177 name="IDisplay" extends="$unknown" 11178 uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD" 11179 wsmap="managed" 11180 > 11170 11181 <desc> 11171 11182 The IDisplay interface represents the virtual machine's display. … … 11434 11445 name="NetworkAttachmentType" 11435 11446 uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf" 11436 >11447 > 11437 11448 <desc> 11438 11449 Network attachment type. … … 11452 11463 name="NetworkAdapterType" 11453 11464 uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c" 11454 >11465 > 11455 11466 <desc> 11456 11467 Network adapter type. … … 11481 11492 11482 11493 <interface 11483 11484 11485 11486 11494 name="INetworkAdapter" extends="$unknown" 11495 uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b" 11496 wsmap="managed" 11497 > 11487 11498 <desc> 11488 11499 Represents a virtual network adapter that is attached to a virtual machine. … … 11650 11661 name="PortMode" 11651 11662 uuid="533b5fe3-0185-4197-86a7-17e37dd39d76" 11652 >11663 > 11653 11664 <desc> 11654 11665 The PortMode enumeration represents possible communication modes for … … 11671 11682 11672 11683 <interface 11673 11674 11675 11676 11684 name="ISerialPort" extends="$unknown" 11685 uuid="937f6970-5103-4745-b78e-d28dcf1479a8" 11686 wsmap="managed" 11687 > 11677 11688 11678 11689 <desc> … … 11700 11711 </desc> 11701 11712 11702 11713 <attribute name="slot" type="unsigned long" readonly="yes"> 11703 11714 <desc> 11704 11715 Slot number this serial port is plugged into. Corresponds to … … 11759 11770 11760 11771 <interface 11761 11762 11763 11764 11772 name="IParallelPort" extends="$unknown" 11773 uuid="0c925f06-dd10-4b77-8de8-294d738c3214" 11774 wsmap="managed" 11775 > 11765 11776 11766 11777 <desc> … … 11779 11790 </desc> 11780 11791 11781 11792 <attribute name="slot" type="unsigned long" readonly="yes"> 11782 11793 <desc> 11783 11794 Slot number this parallel port is plugged into. Corresponds to … … 11819 11830 11820 11831 <interface 11821 11822 11823 11824 11832 name="IMachineDebugger" extends="$unknown" 11833 uuid="b0b2a2dd-0627-4502-91c2-ddc5e77609e0" 11834 wsmap="suppress" 11835 > 11825 11836 <method name="resetStats"> 11826 11837 <desc> … … 11938 11949 11939 11950 <interface 11940 11941 11942 11943 11951 name="IUSBController" extends="$unknown" 11952 uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8" 11953 wsmap="managed" 11954 > 11944 11955 <attribute name="enabled" type="boolean"> 11945 11956 <desc> … … 12096 12107 12097 12108 <interface 12098 12099 12100 12101 12109 name="IUSBDevice" extends="$unknown" 12110 uuid="f8967b0b-4483-400f-92b5-8b675d98a85b" 12111 wsmap="managed" 12112 > 12102 12113 <desc> 12103 12114 The IUSBDevice interface represents a virtual USB device attached to the … … 12185 12196 12186 12197 <interface 12187 12188 12189 12190 12198 name="IUSBDeviceFilter" extends="$unknown" 12199 uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d" 12200 wsmap="managed" 12201 > 12191 12202 <desc> 12192 12203 The IUSBDeviceFilter interface represents an USB device filter used … … 12338 12349 <attribute name="maskedInterfaces" type="unsigned long"> 12339 12350 <desc> 12340 This is an advanced option for hiding one or more USB interfaces12341 from the guest. The value is a bit mask where the bits that are set12342 means the corresponding USB interface should be hidden, masked off12343 if you like.12344 This feature only works on Linux hosts.12351 This is an advanced option for hiding one or more USB interfaces 12352 from the guest. The value is a bit mask where the bits that are set 12353 means the corresponding USB interface should be hidden, masked off 12354 if you like. 12355 This feature only works on Linux hosts. 12345 12356 </desc> 12346 12357 </attribute> … … 12355 12366 12356 12367 <enum 12357 12358 12359 12368 name="USBDeviceState" 12369 uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4" 12370 > 12360 12371 <desc> 12361 12372 USB device state. This enumeration represents all possible states … … 12430 12441 12431 12442 <interface 12432 12433 12434 12435 12443 name="IHostUSBDevice" extends="IUSBDevice" 12444 uuid="173b4b44-d268-4334-a00d-b6521c9a740a" 12445 wsmap="managed" 12446 > 12436 12447 <desc> 12437 12448 The IHostUSBDevice interface represents a physical USB device attached … … 12464 12475 name="USBDeviceFilterAction" 12465 12476 uuid="cbc30a49-2f4e-43b5-9da6-121320475933" 12466 >12477 > 12467 12478 <desc> 12468 12479 Actions for host USB device filters. … … 12482 12493 12483 12494 <interface 12484 12485 12486 12487 12495 name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter" 12496 uuid="4cc70246-d74a-400f-8222-3900489c0374" 12497 wsmap="managed" 12498 > 12488 12499 <desc> 12489 12500 The IHostUSBDeviceFilter interface represents a global filter for a … … 12521 12532 name="AudioDriverType" 12522 12533 uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496" 12523 >12534 > 12524 12535 <desc> 12525 12536 Host audio driver type. … … 12558 12569 name="AudioControllerType" 12559 12570 uuid="7afd395c-42c3-444e-8788-3ce80292f36c" 12560 >12571 > 12561 12572 <desc> 12562 12573 Virtual audio controller type. … … 12569 12580 12570 12581 <interface 12571 12572 12573 12574 12582 name="IAudioAdapter" extends="$unknown" 12583 uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb" 12584 wsmap="managed" 12585 > 12575 12586 <desc> 12576 12587 The IAudioAdapter interface represents the virtual audio adapter of … … 12601 12612 name="AuthType" 12602 12613 uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d" 12603 >12614 > 12604 12615 <desc> 12605 12616 VirtualBox authentication type. … … 12619 12630 12620 12631 <interface 12621 12622 12623 12624 12632 name="IVRDEServer" extends="$unknown" 12633 uuid="468ab3d3-4808-489e-a301-05d60e959fbc" 12634 wsmap="managed" 12635 > 12625 12636 <attribute name="enabled" type="boolean"> 12626 12637 <desc>VRDE server status.</desc> … … 12710 12721 12711 12722 <interface 12712 12713 12714 12715 12723 name="ISharedFolder" extends="$unknown" 12724 uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8" 12725 wsmap="struct" 12726 > 12716 12727 <desc> 12717 12728 The ISharedFolder interface represents a folder in the host computer's … … 12816 12827 12817 12828 <interface 12818 12819 12820 12821 12822 12829 name="IInternalSessionControl" extends="$unknown" 12830 uuid="06ef98a7-f7c0-45ba-bf99-9aca7a4d5530" 12831 internal="yes" 12832 wsmap="suppress" 12833 > 12823 12834 <method name="getPID"> 12824 12835 <desc>PID of the process that has created this Session object. … … 12999 13010 <method name="onCPUExecutionCapChange"> 13000 13011 <desc> 13001 13012 Notification when the CPU execution cap changes. 13002 13013 </desc> 13003 13014 <param name="executionCap" type="unsigned long" dir="in"> 13004 13015 <desc>The new CPU execution cap value. (1-100)</desc> 13005 13016 </param> 13006 13017 </method> … … 13238 13249 13239 13250 <interface 13240 13241 13242 13243 13251 name="ISession" extends="$unknown" 13252 uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D" 13253 wsmap="managed" 13254 > 13244 13255 <desc> 13245 13256 The ISession interface represents a client process and allows for locking … … 13358 13369 name="StorageBus" 13359 13370 uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a" 13360 >13371 > 13361 13372 <desc> 13362 13373 The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy); … … 13376 13387 name="StorageControllerType" 13377 13388 uuid="8a412b8a-f43e-4456-bd37-b474f0879a58" 13378 >13389 > 13379 13390 <desc> 13380 13391 The exact variant of storage controller hardware presented … … 13414 13425 name="ChipsetType" 13415 13426 uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394" 13416 >13427 > 13417 13428 <desc> 13418 13429 Type of emulated chipset (mostly southbridge). … … 13434 13445 uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e" 13435 13446 wsmap="managed" 13436 >13447 > 13437 13448 <desc> 13438 13449 Represents a storage controller that is attached to a virtual machine … … 13455 13466 13456 13467 <attribute name="name" type="wstring" readonly="yes"> 13457 <desc>13468 <desc> 13458 13469 Name of the storage controller, as originally specified with 13459 13470 <link to="IMachine::addStorageController" />. This then uniquely … … 13581 13592 13582 13593 <interface 13583 13584 13585 13586 13587 13588 13594 name="IManagedObjectRef" extends="$unknown" 13595 uuid="9474d09d-2313-46de-b568-a42b8718e8ed" 13596 internal="yes" 13597 wsmap="managed" 13598 wscpp="hardcoded" 13599 > 13589 13600 <desc> 13590 13601 Managed object reference. … … 13631 13642 13632 13643 <interface 13633 13634 13635 13636 13637 13638 13644 name="IWebsessionManager" extends="$unknown" 13645 uuid="dea1b4c7-2de3-418a-850d-7868617f7733" 13646 internal="yes" 13647 wsmap="global" 13648 wscpp="hardcoded" 13649 > 13639 13650 <desc> 13640 13651 Websession manager. This provides essential services … … 13685 13696 name="IPerformanceMetric" extends="$unknown" 13686 13697 uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed" 13687 >13698 > 13688 13699 <desc> 13689 13700 The IPerformanceMetric interface represents parameters of the given … … 13748 13759 uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6" 13749 13760 wsmap="managed" 13750 >13761 > 13751 13762 <desc> 13752 13763 The IPerformanceCollector interface represents a service that collects … … 14051 14062 </param> 14052 14063 <param name="returnUnits" type="wstring" dir="out" safearray="yes"> 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14064 <desc> 14065 Units of measurement for each returned metric. 14066 </desc> 14067 </param> 14068 <param name="returnScales" type="unsigned long" dir="out" safearray="yes"> 14069 <desc> 14070 Divisor that should be applied to return values in order to get 14071 floating point values. For example: 14072 <tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt> 14073 will retrieve the floating point value of i-th sample of the first 14074 metric. 14075 </desc> 14076 </param> 14077 <param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes"> 14078 <desc> 14079 Sequence numbers of the first elements of value sequences of 14080 particular metrics returned in @c returnData. For aggregate metrics 14081 it is the sequence number of the sample the aggregate started 14082 calculation from. 14083 </desc> 14084 </param> 14074 14085 <param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes"> 14075 14086 <desc> … … 14092 14103 14093 14104 </interface> 14094 <enum 14095 name="NATAliasMode"14096 uuid="67772168-50d9-11df-9669-7fb714ee4fa1">14097 <desc></desc>14098 <const name="AliasLog" value="0x1">14105 14106 <enum 14107 name="NATAliasMode" 14108 uuid="67772168-50d9-11df-9669-7fb714ee4fa1" 14109 > 14099 14110 <desc></desc> 14100 </const> 14101 <const name="AliasProxyOnly" value="0x02"> 14102 <desc></desc> 14103 </const> 14104 <const name="AliasUseSamePorts" value="0x04"> 14105 <desc></desc> 14106 </const> 14107 </enum> 14111 <const name="AliasLog" value="0x1"> 14112 <desc></desc> 14113 </const> 14114 <const name="AliasProxyOnly" value="0x02"> 14115 <desc></desc> 14116 </const> 14117 <const name="AliasUseSamePorts" value="0x04"> 14118 <desc></desc> 14119 </const> 14120 </enum> 14121 14108 14122 <enum 14109 14123 name="NATProtocol" 14110 14124 uuid="e90164be-eb03-11de-94af-fff9b1c1b19f" 14111 >14125 > 14112 14126 <desc>Protocol definitions used with NAT port-forwarding rules.</desc> 14113 14127 <const name="UDP" value="0"> … … 14120 14134 14121 14135 <interface 14122 14123 14124 14125 14126 14127 14128 14136 name="INATEngine" extends="$unknown" 14137 uuid="4b286616-eb03-11de-b0fb-1701eca42246" 14138 wsmap="managed" 14139 > 14140 <desc>Interface for managing a NAT engine which is used with a virtual machine. This 14141 allows for changing NAT behavior such as port-forwarding rules. This interface is 14142 used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc> 14129 14143 <attribute name="network" type="wstring"> 14130 14144 <desc>The network attribute of the NAT engine (the same value is used with built-in … … 14398 14412 14399 14413 <!-- 14414 // IVirtualBoxClient 14415 ///////////////////////////////////////////////////////////////////////// 14416 --> 14417 14418 <interface 14419 name="IVirtualBoxClient" extends="$unknown" 14420 uuid="5fe0bd48-1181-40d1-991f-3b02f269a823" 14421 wsmap="suppress" 14422 > 14423 <desc> 14424 Convenience interface for client applications. Treat this as a 14425 singleton, i.e. never create more than one instance of this interface. 14426 14427 At the moment only available for clients of the local API (not usable 14428 via the webservice). Once the session logic is redesigned this might 14429 change. 14430 </desc> 14431 14432 <attribute name="virtualBox" type="IVirtualBox" readonly="yes"> 14433 <desc> 14434 Reference to the server-side API root object. 14435 </desc> 14436 </attribute> 14437 14438 <attribute name="session" type="ISession" readonly="yes"> 14439 <desc> 14440 Create a new session object and return the reference to it. 14441 </desc> 14442 </attribute> 14443 14444 <attribute name="eventSource" type="IEventSource" readonly="yes"> 14445 <desc> 14446 Event source for VirtualBoxClient events. 14447 </desc> 14448 </attribute> 14449 14450 </interface> 14451 14452 <!-- 14400 14453 // Events 14401 14454 ///////////////////////////////////////////////////////////////////////// 14402 14455 --> 14403 14456 <enum 14404 name="VBoxEventType" 14405 uuid="BA0F90B2-3F41-4222-840D-EDD5055476A8"> 14457 name="VBoxEventType" 14458 uuid="BA0F90B2-3F41-4222-840D-EDD5055476A8" 14459 > 14406 14460 14407 14461 <desc> … … 14474 14528 </desc> 14475 14529 </const> 14476 14530 <const name="OnExtraDataCanChange" value="35"> 14477 14531 <desc> 14478 14532 See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>. … … 14640 14694 </desc> 14641 14695 </const> 14696 <const name="OnVBoxSVCUnavailable" value="68"> 14697 <desc> 14698 See <link to="IVBoxSVCUnavailableEvent">IVBoxSVCUnavailableEvent</link>. 14699 </desc> 14700 </const> 14642 14701 14643 14702 <!-- Last event marker --> 14644 <const name="Last" value="6 8">14703 <const name="Last" value="69"> 14645 14704 <desc> 14646 14705 Must be last event, used for iterations and structures relying on numerical event values. … … 14651 14710 14652 14711 <interface 14653 14654 14655 14656 14712 name="IEventSource" extends="$unknown" 14713 uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538" 14714 wsmap="managed" 14715 > 14657 14716 <desc> 14658 14717 Event source. Generally, any object which could generate events can be an event source, … … 14790 14849 14791 14850 <interface 14792 14793 14794 14795 14851 name="IEventListener" extends="$unknown" 14852 uuid="67099191-32e7-4f6c-85ee-422304c71b90" 14853 wsmap="managed" 14854 > 14796 14855 <desc> 14797 14856 Event listener. An event listener can work in either active or passive mode, depending on the way … … 14813 14872 14814 14873 <interface 14815 14816 14817 14818 14874 name="IEvent" extends="$unknown" 14875 uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0" 14876 wsmap="managed" 14877 > 14819 14878 <desc> 14820 14879 Abstract parent interface for VirtualBox events. Actual events will typically implement … … 14939 14998 14940 14999 14941 14942 14943 14944 14945 15000 <interface 15001 name="IReusableEvent" extends="IEvent" 15002 uuid="69bfb134-80f6-4266-8e20-16371f68fa25" 15003 wsmap="managed" 15004 > 14946 15005 <desc>Base abstract interface for all reusable events.</desc> 14947 15006 … … 14959 15018 14960 15019 <interface 14961 14962 14963 14964 15020 name="IMachineEvent" extends="IEvent" 15021 uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e" 15022 wsmap="managed" id="MachineEvent" 15023 > 14965 15024 <desc>Base abstract interface for all machine events.</desc> 14966 15025 … … 14972 15031 14973 15032 <interface 14974 14975 14976 14977 15033 name="IMachineStateChangedEvent" extends="IMachineEvent" 15034 uuid="5748F794-48DF-438D-85EB-98FFD70D18C9" 15035 wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged" 15036 > 14978 15037 <desc>Machine state change event.</desc> 14979 15038 … … 14984 15043 14985 15044 <interface 14986 14987 14988 14989 15045 name="IMachineDataChangedEvent" extends="IMachineEvent" 15046 uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49" 15047 wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged" 15048 > 14990 15049 <desc> 14991 15050 Any of the settings of the given machine has changed. … … 14994 15053 14995 15054 <interface 14996 14997 14998 14999 15055 name="IMediumRegisteredEvent" extends="IEvent" 15056 uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458" 15057 wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered" 15058 > 15000 15059 <desc> 15001 15060 The given medium was registered or unregistered … … 15020 15079 15021 15080 <interface 15022 15023 15024 15025 15081 name="IMachineRegisteredEvent" extends="IMachineEvent" 15082 uuid="c354a762-3ff2-4f2e-8f09-07382ee25088" 15083 wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered" 15084 > 15026 15085 <desc> 15027 15086 The given machine was registered or unregistered … … 15038 15097 15039 15098 <interface 15040 15041 15042 15043 15099 name="ISessionStateChangedEvent" extends="IMachineEvent" 15100 uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e" 15101 wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged" 15102 > 15044 15103 <desc> 15045 15104 The state of the session for the given machine was changed. … … 15055 15114 15056 15115 <interface 15057 15058 15059 15060 15116 name="IGuestPropertyChangedEvent" extends="IMachineEvent" 15117 uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368" 15118 wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged" 15119 > 15061 15120 <desc> 15062 15121 Notification when a guest property has changed. … … 15075 15134 </attribute> 15076 15135 15077 15136 <attribute name="flags" readonly="yes" type="wstring"> 15078 15137 <desc> 15079 15138 The new property flags. … … 15084 15143 15085 15144 <interface 15086 15087 15088 15089 15145 name="ISnapshotEvent" extends="IMachineEvent" 15146 uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22" 15147 wsmap="managed" id="SnapshotEvent" 15148 > 15090 15149 <desc>Base interface for all snapshot events.</desc> 15091 15150 … … 15097 15156 15098 15157 <interface 15099 15100 15101 15102 15158 name="ISnapshotTakenEvent" extends="ISnapshotEvent" 15159 uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1" 15160 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken" 15161 > 15103 15162 <desc> 15104 15163 A new snapshot of the machine has been taken. … … 15108 15167 15109 15168 <interface 15110 15111 15112 15113 15169 name="ISnapshotDeletedEvent" extends="ISnapshotEvent" 15170 uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4" 15171 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted" 15172 > 15114 15173 <desc> 15115 15174 Snapshot of the given machine has been deleted. … … 15126 15185 15127 15186 <interface 15128 15129 15130 15131 15187 name="ISnapshotChangedEvent" extends="ISnapshotEvent" 15188 uuid="07541941-8079-447a-a33e-47a69c7980db" 15189 wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged" 15190 > 15132 15191 <desc> 15133 15192 Snapshot properties (name and/or description) have been changed. … … 15137 15196 15138 15197 <interface 15139 15140 15141 15142 15198 name="IMousePointerShapeChangedEvent" extends="IEvent" 15199 uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef" 15200 wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged" 15201 > 15143 15202 <desc> 15144 15203 Notification when the guest mouse pointer shape has … … 15168 15227 <attribute name="width" type="unsigned long" readonly="yes"> 15169 15228 <desc> 15170 Width of the pointer shape in pixels.15229 Width of the pointer shape in pixels. 15171 15230 </desc> 15172 15231 </attribute> 15173 15232 <attribute name="height" type="unsigned long" readonly="yes"> 15174 15233 <desc> 15175 Height of the pointer shape in pixels.15234 Height of the pointer shape in pixels. 15176 15235 </desc> 15177 15236 </attribute> … … 15210 15269 15211 15270 <interface 15212 15213 15214 15215 15271 name="IMouseCapabilityChangedEvent" extends="IEvent" 15272 uuid="d633ad48-820c-4207-b46c-6bd3596640d5" 15273 wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged" 15274 > 15216 15275 <desc> 15217 15276 Notification when the mouse capabilities reported by the … … 15236 15295 15237 15296 <interface 15238 15239 15240 15241 15297 name="IKeyboardLedsChangedEvent" extends="IEvent" 15298 uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F" 15299 wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged" 15300 > 15242 15301 <desc> 15243 15302 Notification when the guest OS executes the KBD_CMD_SET_LEDS command … … 15262 15321 15263 15322 <interface 15264 15265 15266 15267 15323 name="IStateChangedEvent" extends="IEvent" 15324 uuid="4376693C-CF37-453B-9289-3B0F521CAF27" 15325 wsmap="managed" autogen="VBoxEvent" id="OnStateChanged" 15326 > 15268 15327 <desc> 15269 15328 Notification when the execution state of the machine has changed. … … 15278 15337 15279 15338 <interface 15280 15281 15282 15283 15339 name="IAdditionsStateChangedEvent" extends="IEvent" 15340 uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A" 15341 wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged" 15342 > 15284 15343 <desc> 15285 15344 Notification when a Guest Additions property changes. … … 15290 15349 15291 15350 <interface 15292 15293 15294 15295 15351 name="INetworkAdapterChangedEvent" extends="IEvent" 15352 uuid="08889892-1EC6-4883-801D-77F56CFD0103" 15353 wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged" 15354 > 15296 15355 <desc> 15297 15356 Notification when a property of one of the … … 15308 15367 15309 15368 <interface 15310 15311 15312 15313 15369 name="ISerialPortChangedEvent" extends="IEvent" 15370 uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C" 15371 wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged" 15372 > 15314 15373 <desc> 15315 15374 Notification when a property of one of the … … 15326 15385 15327 15386 <interface 15328 15329 15330 15331 15387 name="IParallelPortChangedEvent" extends="IEvent" 15388 uuid="813C99FC-9849-4F47-813E-24A75DC85615" 15389 wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged" 15390 > 15332 15391 <desc> 15333 15392 Notification when a property of one of the … … 15344 15403 15345 15404 <interface 15346 15347 15348 15349 15405 name="IStorageControllerChangedEvent" extends="IEvent" 15406 uuid="715212BF-DA59-426E-8230-3831FAA52C56" 15407 wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged" 15408 > 15350 15409 <desc> 15351 15410 Notification when a … … 15356 15415 15357 15416 <interface 15358 15359 15360 15361 15417 name="IMediumChangedEvent" extends="IEvent" 15418 uuid="0FE2DA40-5637-472A-9736-72019EABD7DE" 15419 wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged" 15420 > 15362 15421 <desc> 15363 15422 Notification when a … … 15373 15432 15374 15433 <interface 15375 15376 15377 15378 15434 name="ICPUChangedEvent" extends="IEvent" 15435 uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D" 15436 wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged" 15437 > 15379 15438 <desc> 15380 15439 Notification when a CPU changes. … … 15397 15456 wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged" 15398 15457 > 15399 <desc>15458 <desc> 15400 15459 Notification when the CPU execution cap changes. 15401 </desc>15402 15403 15404 15405 15406 15460 </desc> 15461 <attribute name="executionCap" type="unsigned long" readonly="yes"> 15462 <desc> 15463 The new CPU execution cap value. (1-100) 15464 </desc> 15465 </attribute> 15407 15466 </interface> 15408 15467 … … 15412 15471 wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard" 15413 15472 > 15414 <desc>15473 <desc> 15415 15474 Notification when guest keyboard event happens. 15416 </desc>15417 15418 15419 15420 15421 15475 </desc> 15476 <attribute name="scancodes" type="long" safearray="yes" readonly="yes"> 15477 <desc> 15478 Array of scancodes. 15479 </desc> 15480 </attribute> 15422 15481 </interface> 15423 15482 … … 15427 15486 wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse" 15428 15487 > 15429 <desc>15488 <desc> 15430 15489 Notification when guest mouse event happens. 15431 </desc>15432 15433 <attribute name="absolute" type="boolean" readonly="yes">15434 <desc>15435 If this event is relative or absolute.15436 </desc>15437 </attribute>15438 15439 <attribute name="x" type="long" readonly="yes">15440 <desc>15441 New X position, or X delta.15442 </desc>15443 </attribute>15444 15445 <attribute name="y" type="long" readonly="yes">15446 <desc>15447 New Y position, or Y delta.15448 </desc>15449 </attribute>15450 15451 <attribute name="z" type="long" readonly="yes">15452 <desc>15453 Z delta.15454 </desc>15455 </attribute>15456 15457 <attribute name="w" type="long" readonly="yes">15458 <desc>15459 W delta.15460 </desc>15461 </attribute>15462 15463 <attribute name="buttons" type="long" readonly="yes">15464 <desc>15465 Button state bitmask.15466 </desc>15467 </attribute>15468 15469 15470 15471 15472 15473 15474 15475 15476 15490 </desc> 15491 15492 <attribute name="absolute" type="boolean" readonly="yes"> 15493 <desc> 15494 If this event is relative or absolute. 15495 </desc> 15496 </attribute> 15497 15498 <attribute name="x" type="long" readonly="yes"> 15499 <desc> 15500 New X position, or X delta. 15501 </desc> 15502 </attribute> 15503 15504 <attribute name="y" type="long" readonly="yes"> 15505 <desc> 15506 New Y position, or Y delta. 15507 </desc> 15508 </attribute> 15509 15510 <attribute name="z" type="long" readonly="yes"> 15511 <desc> 15512 Z delta. 15513 </desc> 15514 </attribute> 15515 15516 <attribute name="w" type="long" readonly="yes"> 15517 <desc> 15518 W delta. 15519 </desc> 15520 </attribute> 15521 15522 <attribute name="buttons" type="long" readonly="yes"> 15523 <desc> 15524 Button state bitmask. 15525 </desc> 15526 </attribute> 15527 15528 </interface> 15529 15530 15531 <interface 15532 name="IVRDEServerChangedEvent" extends="IEvent" 15533 uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c" 15534 wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged" 15535 > 15477 15536 <desc> 15478 15537 Notification when a property of the … … 15483 15542 </interface> 15484 15543 15485 15486 15487 15488 15489 15544 <interface 15545 name="IVRDEServerInfoChangedEvent" extends="IEvent" 15546 uuid="dd6a1080-e1b7-4339-a549-f0878115596e" 15547 wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged" 15548 > 15490 15549 <desc> 15491 15550 Notification when the status of the VRDE server changes. Interested callees … … 15496 15555 15497 15556 <interface 15498 15499 15500 15501 15557 name="IUSBControllerChangedEvent" extends="IEvent" 15558 uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83" 15559 wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged" 15560 > 15502 15561 <desc> 15503 15562 Notification when a property of the virtual … … 15509 15568 15510 15569 <interface 15511 15512 15513 15514 15570 name="IUSBDeviceStateChangedEvent" extends="IEvent" 15571 uuid="806da61b-6679-422a-b629-51b06b0c6d93" 15572 wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged" 15573 > 15515 15574 <desc> 15516 15575 Notification when a USB device is attached to or detached from … … 15549 15608 </interface> 15550 15609 15551 15552 15553 15554 15555 15610 <interface 15611 name="ISharedFolderChangedEvent" extends="IEvent" 15612 uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B" 15613 wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged" 15614 > 15556 15615 <desc> 15557 15616 Notification when a shared folder is added or removed. … … 15573 15632 </interface> 15574 15633 15575 15576 15577 15578 15579 15634 <interface 15635 name="IRuntimeErrorEvent" extends="IEvent" 15636 uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C" 15637 wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError" 15638 > 15580 15639 <desc> 15581 15640 Notification when an error happens during the virtual … … 15638 15697 </desc> 15639 15698 </attribute> 15640 15699 <attribute name="message" type="wstring" readonly="yes"> 15641 15700 <desc> 15642 15701 Optional error message. … … 15646 15705 15647 15706 15648 15649 15650 15651 15652 15653 15707 <interface 15708 name="IEventSourceChangedEvent" extends="IEvent" 15709 uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a" 15710 waitable="yes" 15711 wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged" 15712 > 15654 15713 <desc> 15655 15714 Notification when an event source state changes (listener added or removed). … … 15670 15729 15671 15730 <interface 15672 15673 15674 15675 15731 name="IExtraDataChangedEvent" extends="IEvent" 15732 uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7" 15733 wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged" 15734 > 15676 15735 <desc> 15677 15736 Notification when machine specific or global extra data … … 15697 15756 15698 15757 <interface 15699 15700 15701 15702 15758 name="IVetoEvent" extends="IEvent" 15759 uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007" 15760 wsmap="managed" 15761 > 15703 15762 <desc>Base abstract interface for veto events.</desc> 15704 15763 … … 15739 15798 15740 15799 <interface 15741 15742 15743 15744 15745 15800 name="IExtraDataCanChangeEvent" extends="IVetoEvent" 15801 uuid="245d88bd-800a-40f8-87a6-170d02249a55" 15802 wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange" 15803 waitable="true" 15804 > 15746 15805 <desc> 15747 15806 Notification when someone tries to change extra data for … … 15768 15827 15769 15828 <interface 15770 15771 15772 15773 15774 15829 name="ICanShowWindowEvent" extends="IVetoEvent" 15830 uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9" 15831 wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow" 15832 waitable="true" 15833 > 15775 15834 <desc> 15776 15835 Notification when a call to … … 15787 15846 15788 15847 <interface 15789 15790 15791 15792 15793 15848 name="IShowWindowEvent" extends="IEvent" 15849 uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2" 15850 wsmap="managed" autogen="VBoxEvent" id="OnShowWindow" 15851 waitable="true" 15852 > 15794 15853 <desc> 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15854 Notification when a call to 15855 <link to="IMachine::showConsoleWindow"/> 15856 requests the console window to be activated and brought to 15857 foreground on the desktop of the host PC. 15858 15859 This notification should cause the VM console process to 15860 perform the requested action as described above. If it is 15861 impossible to do it at a time of this notification, this 15862 method should return a failure. 15863 15864 Note that many modern window managers on many platforms 15865 implement some sort of focus stealing prevention logic, so 15866 that it may be impossible to activate a window without the 15867 help of the currently active application (which is supposedly 15868 an initiator of this notification). In this case, this method 15869 must return a non-zero identifier that represents the 15870 top-level window of the VM console process. The caller, if it 15871 represents a currently active process, is responsible to use 15872 this identifier (in a platform-dependent manner) to perform 15873 actual window activation. 15874 15875 This method must set @a winId to zero if it has performed all 15876 actions necessary to complete the request and the console 15877 window is now active and in foreground, to indicate that no 15878 further action is required on the caller's side. 15820 15879 </desc> 15821 15880 <attribute name="winId" type="long long"> 15822 15881 <desc> 15823 15824 15825 15826 15882 Platform-dependent identifier of the top-level VM console 15883 window, or zero if this method has performed all actions 15884 necessary to implement the <i>show window</i> semantics for 15885 the given platform and/or this VirtualBox front-end. 15827 15886 </desc> 15828 15887 </attribute> … … 15834 15893 wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect" 15835 15894 > 15836 <desc>15895 <desc> 15837 15896 Notification when NAT redirect rule added or removed. 15838 </desc>15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15897 </desc> 15898 <attribute name="slot" type="unsigned long" readonly="yes"> 15899 <desc> 15900 Adapter which NAT attached to. 15901 </desc> 15902 </attribute> 15903 <attribute name="remove" type="boolean" readonly="yes"> 15904 <desc> 15905 Whether rule remove or add. 15906 </desc> 15907 </attribute> 15908 <attribute name="name" type="wstring" readonly="yes"> 15909 <desc> 15910 Name of the rule. 15911 </desc> 15912 </attribute> 15913 <attribute name="proto" type="NATProtocol" readonly="yes"> 15914 <desc> 15915 Protocol (TCP or UDP) of the redirect rule. 15916 </desc> 15917 </attribute> 15918 <attribute name="hostIp" type="wstring" readonly="yes"> 15919 <desc> 15920 Host ip address to bind socket on. 15921 </desc> 15922 </attribute> 15923 <attribute name="hostPort" type="long" readonly="yes"> 15924 <desc> 15925 Host port to bind socket on. 15926 </desc> 15927 </attribute> 15928 <attribute name="guestIp" type="wstring" readonly="yes"> 15929 <desc> 15930 Guest ip address to redirect to. 15931 </desc> 15932 </attribute> 15933 <attribute name="guestPort" type="long" readonly="yes"> 15934 <desc> 15935 Guest port to redirect to. 15936 </desc> 15937 </attribute> 15879 15938 </interface> 15880 15939 15881 15940 <interface 15882 15883 15884 15885 15941 name="IHostPciDevicePlugEvent" extends="IMachineEvent" 15942 waitable="yes" 15943 uuid="EDD4782B-DB74-43A0-B724-2BAA36F039CC" 15944 wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug" 15886 15945 > 15887 <desc>15946 <desc> 15888 15947 Notification when host PCI device is plugged/unplugged. 15889 </desc>15890 15891 <attribute name="plugged" type="boolean" readonly="yes">15948 </desc> 15949 15950 <attribute name="plugged" type="boolean" readonly="yes"> 15892 15951 <desc> 15893 15952 If device successfully plugged or unplugged. 15894 15953 </desc> 15895 </attribute>15896 15897 <attribute name="success" type="boolean" readonly="yes">15954 </attribute> 15955 15956 <attribute name="success" type="boolean" readonly="yes"> 15898 15957 <desc> 15899 15958 If operation was successful, if false - 'message' attribute 15900 15959 may be of interest. 15901 15960 </desc> 15902 </attribute>15903 15904 <attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">15961 </attribute> 15962 15963 <attribute name="attachment" type="IPciDeviceAttachment" readonly="yes"> 15905 15964 <desc> 15906 15965 Attachment info for this device. 15907 15966 </desc> 15908 </attribute>15909 15910 <attribute name="eventContext" type="IEventContext" readonly="yes">15967 </attribute> 15968 15969 <attribute name="eventContext" type="IEventContext" readonly="yes"> 15911 15970 <desc> 15912 15971 Context object, passed into attachHostPciDevice() and 15913 15972 attachHostPciDevice(). 15914 15973 </desc> 15915 </attribute>15916 15917 <attribute name="message" type="wstring" readonly="yes">15974 </attribute> 15975 15976 <attribute name="message" type="wstring" readonly="yes"> 15918 15977 <desc> 15919 15978 Optional error message. … … 15921 15980 </attribute> 15922 15981 15982 </interface> 15983 15984 <interface 15985 name="IVBoxSVCUnavailableEvent" extends="IEvent" 15986 uuid="99f6b352-f5c1-4d15-9c32-939158da8983" 15987 wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCUnavailable" 15988 > 15989 <desc> 15990 Notification when VBoxSVC becomes unavailable (due to a crash or similar 15991 unexpected circumstances). 15992 </desc> 15923 15993 </interface> 15924 15994 … … 15931 16001 15932 16002 <module name="VBoxC" context="InprocServer" threadingModel="Free"> 16003 <class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba" 16004 namespace="virtualbox.org"> 16005 <interface name="IVirtualBoxClient" default="yes"/> 16006 </class> 16007 15933 16008 <class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214" 15934 16009 namespace="virtualbox.org"> -
trunk/src/VBox/Main/include/VirtualBoxClientImpl.h
r34215 r34416 2 2 3 3 /** @file 4 * Header file for the OUSBDevice (IUSBDevice) class, VBoxC.4 * Header file for the VirtualBoxClient (IVirtualBoxClient) class, VBoxC. 5 5 */ 6 6 7 7 /* 8 * Copyright (C) 20 06-2009Oracle Corporation8 * Copyright (C) 2010 Oracle Corporation 9 9 * 10 10 * This file is part of VirtualBox Open Source Edition (OSE), as … … 17 17 */ 18 18 19 #ifndef ____H_ USBDEVICEIMPL20 #define ____H_ USBDEVICEIMPL19 #ifndef ____H_VIRTUALBOXCLIENTIMPL 20 #define ____H_VIRTUALBOXCLIENTIMPL 21 21 22 22 #include "VirtualBoxBase.h" 23 #include "EventImpl.h" 23 24 24 /** 25 * Object class used for maintaining devices attached to a USB controller. 26 * Generally this contains much less information. 27 */ 28 class ATL_NO_VTABLE OUSBDevice : 25 class ATL_NO_VTABLE VirtualBoxClient : 29 26 public VirtualBoxBase, 30 VBOX_SCRIPTABLE_IMPL(IUSBDevice) 27 VBOX_SCRIPTABLE_IMPL(IVirtualBoxClient) 28 #ifdef RT_OS_WINDOWS 29 , public CComCoClass<VirtualBoxClient, &CLSID_VirtualBoxClient> 30 #endif 31 31 { 32 32 public: 33 33 34 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT( OUSBDevice, IUSBDevice)34 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VirtualBoxClient, IVirtualBoxClient) 35 35 36 DECLARE_NOT_AGGREGATABLE(OUSBDevice) 36 DECLARE_CLASSFACTORY_SINGLETON(VirtualBoxClient) 37 38 DECLARE_REGISTRY_RESOURCE(IDR_VIRTUALBOX) 39 DECLARE_NOT_AGGREGATABLE(VirtualBoxClient) 37 40 38 41 DECLARE_PROTECT_FINAL_CONSTRUCT() 39 42 40 BEGIN_COM_MAP( OUSBDevice)41 COM_INTERFACE_ENTRY (ISupportErrorInfo)42 COM_INTERFACE_ENTRY (IUSBDevice)43 COM_INTERFACE_ENTRY 2 (IDispatch, IUSBDevice)43 BEGIN_COM_MAP(VirtualBoxClient) 44 COM_INTERFACE_ENTRY2(IDispatch, IVirtualBoxClient) 45 COM_INTERFACE_ENTRY(ISupportErrorInfo) 46 COM_INTERFACE_ENTRY(IVirtualBoxClient) 44 47 END_COM_MAP() 45 48 46 DECLARE_EMPTY_CTOR_DTOR (OUSBDevice)49 DECLARE_EMPTY_CTOR_DTOR(VirtualBoxClient) 47 50 48 51 HRESULT FinalConstruct(); … … 50 53 51 54 // public initializer/uninitializer for internal purposes only 52 HRESULT init (IUSBDevice *a_pUSBDevice);55 HRESULT init(); 53 56 void uninit(); 54 57 55 58 // IUSBDevice properties 56 STDMETHOD(COMGETTER(Id))(BSTR *aId); 57 STDMETHOD(COMGETTER(VendorId))(USHORT *aVendorId); 58 STDMETHOD(COMGETTER(ProductId))(USHORT *aProductId); 59 STDMETHOD(COMGETTER(Revision))(USHORT *aRevision); 60 STDMETHOD(COMGETTER(Manufacturer))(BSTR *aManufacturer); 61 STDMETHOD(COMGETTER(Product))(BSTR *aProduct); 62 STDMETHOD(COMGETTER(SerialNumber))(BSTR *aSerialNumber); 63 STDMETHOD(COMGETTER(Address))(BSTR *aAddress); 64 STDMETHOD(COMGETTER(Port))(USHORT *aPort); 65 STDMETHOD(COMGETTER(Version))(USHORT *aVersion); 66 STDMETHOD(COMGETTER(PortVersion))(USHORT *aPortVersion); 67 STDMETHOD(COMGETTER(Remote))(BOOL *aRemote); 68 69 // public methods only for internal purposes 70 const Guid &id() const { return mData.id; } 59 STDMETHOD(COMGETTER(VirtualBox))(IVirtualBox **aVirtualBox); 60 STDMETHOD(COMGETTER(Session))(ISession **aSession); 61 STDMETHOD(COMGETTER(EventSource))(IEventSource **aEventSource); 71 62 72 63 private: 73 64 65 static DECLCALLBACK(int) SVCWatcherThread(RTTHREAD ThreadSelf, void *pvUser); 66 74 67 struct Data 75 68 { 76 Data() : vendorId (0), productId (0), revision (0), port (0),77 version (1), portVersion (1), remote (FALSE){}69 Data() 70 {} 78 71 79 /** The UUID of this device. */80 const Guid id;72 const ComPtr<IVirtualBox> m_pVirtualBox; 73 const ComObjPtr<EventSource> m_pEventSource; 81 74 82 /** The vendor id of this USB device. */ 83 const USHORT vendorId; 84 /** The product id of this USB device. */ 85 const USHORT productId; 86 /** The product revision number of this USB device. 87 * (high byte = integer; low byte = decimal) */ 88 const USHORT revision; 89 /** The Manufacturer string. (Quite possibly NULL.) */ 90 const Bstr manufacturer; 91 /** The Product string. (Quite possibly NULL.) */ 92 const Bstr product; 93 /** The SerialNumber string. (Quite possibly NULL.) */ 94 const Bstr serialNumber; 95 /** The host specific address of the device. */ 96 const Bstr address; 97 /** The host port number. */ 98 const USHORT port; 99 /** The major USB version number of the device. */ 100 const USHORT version; 101 /** The major USB version number of the port the device is attached to. */ 102 const USHORT portVersion; 103 /** Remote (VRDP) or local device. */ 104 const BOOL remote; 75 RTTHREAD m_ThreadWatcher; 76 RTSEMEVENT m_SemEvWatcher; 105 77 }; 106 78 … … 108 80 }; 109 81 110 #endif // ____H_ USBDEVICEIMPL82 #endif // ____H_VIRTUALBOXCLIENTIMPL 111 83 /* vi: set tabstop=4 shiftwidth=4 expandtab: */ -
trunk/src/VBox/Main/win/dllmain.cpp
r33590 r34416 20 20 21 21 #include <SessionImpl.h> 22 #include <VirtualBoxClientImpl.h> 22 23 23 24 #include <atlbase.h> … … 30 31 BEGIN_OBJECT_MAP(ObjectMap) 31 32 OBJECT_ENTRY(CLSID_Session, Session) 33 OBJECT_ENTRY(CLSID_VirtualBoxClient, VirtualBoxClient) 32 34 END_OBJECT_MAP() 33 35
Note:
See TracChangeset
for help on using the changeset viewer.