code string | signature string | docstring string | loss_without_docstring float64 | loss_with_docstring float64 | factor float64 |
|---|---|---|---|---|---|
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(bootable, bool):
raise TypeError("bootable can only be an instance of type bool")
self._call("setStorageControllerBootable",
... | def set_storage_controller_bootable(self, name, bootable) | Sets the bootable flag of the storage controller with the given name.
in name of type str
in bootable of type bool
raises :class:`VBoxErrorObjectNotFound`
A storage controller with given name doesn't exist.
raises :class:`VBoxErrorObjectInUse`
Another ... | 3.300641 | 3.411235 | 0.96758 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
controller = self._call("addUSBContro... | def add_usb_controller(self, name, type_p) | Adds a new USB controller to the machine and returns it as an instance of
:py:class:`IUSBController` .
in name of type str
in type_p of type :class:`USBControllerType`
return controller of type :class:`IUSBController`
raises :class:`VBoxErrorObjectInUse`
A USB con... | 3.587393 | 2.941104 | 1.219744 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("removeUSBController",
in_p=[name]) | def remove_usb_controller(self, name) | Removes a USB controller from the machine.
in name of type str
raises :class:`VBoxErrorObjectNotFound`
A USB controller with given type doesn't exist. | 7.441786 | 8.077291 | 0.921322 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
controller = self._call("getUSBControllerByName",
in_p=[name])
controller = IUSBController(controller)
return controller | def get_usb_controller_by_name(self, name) | Returns a USB controller with the given type.
in name of type str
return controller of type :class:`IUSBController`
raises :class:`VBoxErrorObjectNotFound`
A USB controller with given name doesn't exist. | 6.128143 | 5.70674 | 1.073843 |
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
controllers = self._call("getUSBControllerCountByType",
in_p=[type_p])
return controllers | def get_usb_controller_count_by_type(self, type_p) | Returns the number of USB controllers of the given type attached to the VM.
in type_p of type :class:`USBControllerType`
return controllers of type int | 5.143543 | 4.670863 | 1.101197 |
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
port = self._call("getSerialPort",
in_p=[slot])
port = ISerialPort(port)
return port | def get_serial_port(self, slot) | Returns the serial port associated with the given slot.
Slots are numbered sequentially, starting with zero. The total
number of serial ports per machine is defined by the
:py:func:`ISystemProperties.serial_port_count` property,
so the maximum slot number is one less than that property'... | 8.098065 | 7.58515 | 1.067621 |
if not isinstance(slot, baseinteger):
raise TypeError("slot can only be an instance of type baseinteger")
port = self._call("getParallelPort",
in_p=[slot])
port = IParallelPort(port)
return port | def get_parallel_port(self, slot) | Returns the parallel port associated with the given slot.
Slots are numbered sequentially, starting with zero. The total
number of parallel ports per machine is defined by the
:py:func:`ISystemProperties.parallel_port_count` property,
so the maximum slot number is one less than that pro... | 7.892173 | 7.687861 | 1.026576 |
if not isinstance(property_p, CPUPropertyType):
raise TypeError("property_p can only be an instance of type CPUPropertyType")
value = self._call("getCPUProperty",
in_p=[property_p])
return value | def get_cpu_property(self, property_p) | Returns the virtual CPU boolean value of the specified property.
in property_p of type :class:`CPUPropertyType`
Property type to query.
return value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property. | 5.815091 | 5.702897 | 1.019673 |
if not isinstance(property_p, CPUPropertyType):
raise TypeError("property_p can only be an instance of type CPUPropertyType")
if not isinstance(value, bool):
raise TypeError("value can only be an instance of type bool")
self._call("setCPUProperty",
... | def set_cpu_property(self, property_p, value) | Sets the virtual CPU boolean value of the specified property.
in property_p of type :class:`CPUPropertyType`
Property type to query.
in value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property. | 3.637514 | 3.180219 | 1.143793 |
if not isinstance(ordinal, baseinteger):
raise TypeError("ordinal can only be an instance of type baseinteger")
(idx, idx_sub, val_eax, val_ebx, val_ecx, val_edx) = self._call("getCPUIDLeafByOrdinal",
in_p=[ordinal])
return (idx, idx_sub, val_eax, val_eb... | def get_cpuid_leaf_by_ordinal(self, ordinal) | Used to enumerate CPUID information override values.
in ordinal of type int
The ordinal number of the leaf to get.
out idx of type int
CPUID leaf index.
out idx_sub of type int
CPUID leaf sub-index.
out val_eax of type int
CPUID leaf va... | 4.813761 | 3.276221 | 1.469303 |
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
if not isinstance(idx_sub, baseinteger):
raise TypeError("idx_sub can only be an instance of type baseinteger")
(val_eax, val_ebx, val_ecx, val_edx) = self._ca... | def get_cpuid_leaf(self, idx, idx_sub) | 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... | 3.230939 | 2.600621 | 1.242372 |
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
if not isinstance(idx_sub, baseinteger):
raise TypeError("idx_sub can only be an instance of type baseinteger")
if not isinstance(val_eax, baseinteger):
... | def set_cpuid_leaf(self, idx, idx_sub, val_eax, val_ebx, val_ecx, val_edx) | 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 - 0x... | 1.709541 | 1.624509 | 1.052343 |
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
if not isinstance(idx_sub, baseinteger):
raise TypeError("idx_sub can only be an instance of type baseinteger")
self._call("removeCPUIDLeaf",
... | def remove_cpuid_leaf(self, idx, idx_sub) | Removes the virtual CPU cpuid leaf for the specified index
in idx of type int
CPUID leaf index.
in idx_sub of type int
CPUID leaf sub-index (ECX). Set to 0xffffffff (or 0) if not applicable.
The 0xffffffff value works like a wildcard.
raises :class:`OleErr... | 3.933336 | 3.954033 | 0.994766 |
if not isinstance(property_p, HWVirtExPropertyType):
raise TypeError("property_p can only be an instance of type HWVirtExPropertyType")
value = self._call("getHWVirtExProperty",
in_p=[property_p])
return value | def get_hw_virt_ex_property(self, property_p) | Returns the value of the specified hardware virtualization boolean property.
in property_p of type :class:`HWVirtExPropertyType`
Property type to query.
return value of type bool
Property value.
raises :class:`OleErrorInvalidarg`
Invalid property. | 5.452826 | 4.554702 | 1.197186 |
if not isinstance(property_p, HWVirtExPropertyType):
raise TypeError("property_p can only be an instance of type HWVirtExPropertyType")
if not isinstance(value, bool):
raise TypeError("value can only be an instance of type bool")
self._call("setHWVirtExProperty",... | def set_hw_virt_ex_property(self, property_p, value) | Sets a new value for the specified hardware virtualization boolean property.
in property_p of type :class:`HWVirtExPropertyType`
Property type to set.
in value of type bool
New property value.
raises :class:`OleErrorInvalidarg`
Invalid property. | 3.461121 | 2.902058 | 1.192644 |
if not isinstance(settings_file_path, basestring):
raise TypeError("settings_file_path can only be an instance of type basestring")
progress = self._call("setSettingsFilePath",
in_p=[settings_file_path])
progress = IProgress(progress)
return prog... | def set_settings_file_path(self, settings_file_path) | Currently, it is an error to change this property on any machine.
Later this will allow setting a new path for the settings file, with
automatic relocation of all files (including snapshots and disk images)
which are inside the base directory. This operation is only allowed
when there ar... | 5.611414 | 4.905711 | 1.143854 |
if not isinstance(media, list):
raise TypeError("media can only be an instance of type list")
for a in media[:10]:
if not isinstance(a, IMedium):
raise TypeError(
"array can only contain objects of type IMedium")
progress =... | def delete_config(self, media) | Deletes the files associated with this machine from disk. If medium objects are passed
in with the @a aMedia argument, they are closed and, if closing was successful, their
storage files are deleted as well. For convenience, this array of media files can be
the same as the one returned from a pr... | 8.027163 | 5.705698 | 1.406868 |
if not isinstance(appliance, IAppliance):
raise TypeError("appliance can only be an instance of type IAppliance")
if not isinstance(location, basestring):
raise TypeError("location can only be an instance of type basestring")
description = self._call("exportTo",
... | def export_to(self, appliance, location) | Exports the machine to an OVF appliance. See :py:class:`IAppliance` for the
steps required to export VirtualBox machines to OVF.
in appliance of type :class:`IAppliance`
Appliance to export this machine to.
in location of type str
The target location.
return d... | 4.586138 | 3.343781 | 1.371543 |
if not isinstance(name_or_id, basestring):
raise TypeError("name_or_id can only be an instance of type basestring")
snapshot = self._call("findSnapshot",
in_p=[name_or_id])
snapshot = ISnapshot(snapshot)
return snapshot | def find_snapshot(self, name_or_id) | Returns a snapshot of this machine with the given name or UUID.
Returns a snapshot of this machine with the given UUID.
A @c null argument can be used to obtain the first snapshot
taken on this machine. To traverse the whole tree of snapshots
starting from the root, inspect the ... | 5.235299 | 4.255211 | 1.230327 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
(value, timestamp, flags) = self._call("getGuestProperty",
in_p=[name])
return (value, timestamp, flags) | def get_guest_property(self, name) | Reads an entry from the machine's guest property store.
in name of type str
The name of the property to read.
out value of type str
The value of the property. If the property does not exist then this
will be empty.
out timestamp of type int
The ... | 6.92255 | 5.819616 | 1.18952 |
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
value = self._call("getGuestPropertyValue",
in_p=[property_p])
return value | def get_guest_property_value(self, property_p) | Reads a value from the machine's guest property store.
in property_p of type str
The name of the property to read.
return value of type str
The value of the property. If the property does not exist then this
will be empty.
raises :class:`VBoxErrorInvalidVmS... | 5.1452 | 5.373836 | 0.957454 |
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
if not isinstance(flags, basestring):
... | def set_guest_property(self, property_p, value, flags) | Sets, changes or deletes an entry in the machine's guest property
store.
in property_p of type str
The name of the property to set, change or delete.
in value of type str
The new value of the property to set, change or delete. If the
property does not yet ex... | 2.395716 | 2.301789 | 1.040806 |
if not isinstance(property_p, basestring):
raise TypeError("property_p can only be an instance of type basestring")
if not isinstance(value, basestring):
raise TypeError("value can only be an instance of type basestring")
self._call("setGuestPropertyValue",
... | def set_guest_property_value(self, property_p, value) | Sets or changes a value in the machine's guest property
store. The flags field will be left unchanged or created empty for a
new property.
in property_p of type str
The name of the property to set or change.
in value of type str
The new value of the property to ... | 3.080727 | 3.164372 | 0.973567 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("deleteGuestProperty",
in_p=[name]) | def delete_guest_property(self, name) | Deletes an entry from the machine's guest property store.
in name of type str
The name of the property to delete.
raises :class:`VBoxErrorInvalidVmState`
Machine session is not open. | 7.74673 | 8.060006 | 0.961132 |
if not isinstance(patterns, basestring):
raise TypeError("patterns can only be an instance of type basestring")
(names, values, timestamps, flags) = self._call("enumerateGuestProperties",
in_p=[patterns])
return (names, values, timestamps, flags) | def enumerate_guest_properties(self, patterns) | Return a list of the guest properties matching a set of patterns along
with their values, timestamps and flags.
in patterns of type str
The patterns to match the properties against, separated by '|'
characters. If this is empty or @c null, all properties will match.
out... | 6.345342 | 5.38211 | 1.178969 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(origin_x, origin_y, width, height, enabled) = self._call("querySavedGuestScreenInfo",
in_p=[screen_id])
return (origin_x, origin_y, width... | def query_saved_guest_screen_info(self, screen_id) | Returns the guest dimensions from the saved state.
in screen_id of type int
Saved guest screen to query info from.
out origin_x of type int
The X position of the guest monitor top left corner.
out origin_y of type int
The Y position of the guest monitor top... | 5.13683 | 4.538207 | 1.131907 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(bitmap_formats, width, height) = self._call("querySavedScreenshotInfo",
in_p=[screen_id])
bitmap_formats = [BitmapFormat(a) for a in bitm... | def query_saved_screenshot_info(self, screen_id) | Returns available formats and size of the screenshot from saved state.
in screen_id of type int
Saved guest screen to query info from.
out width of type int
Image width.
out height of type int
Image height.
return bitmap_formats of type :class:`Bit... | 5.304158 | 4.523812 | 1.172497 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(bitmap_format, BitmapFormat):
raise TypeError("bitmap_format can only be an instance of type BitmapFormat")
(data, width, height)... | def read_saved_screenshot_to_array(self, screen_id, bitmap_format) | Screenshot in requested format is retrieved to an array of bytes.
in screen_id of type int
Saved guest screen to read from.
in bitmap_format of type :class:`BitmapFormat`
The requested format.
out width of type int
Image width.
out height of type i... | 3.588174 | 3.603858 | 0.995648 |
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
self._call("hotPlugCPU",
in_p=[cpu]) | def hot_plug_cpu(self, cpu) | Plugs a CPU into the machine.
in cpu of type int
The CPU id to insert. | 9.505809 | 10.120806 | 0.939234 |
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
self._call("hotUnplugCPU",
in_p=[cpu]) | def hot_unplug_cpu(self, cpu) | Removes a CPU from the machine.
in cpu of type int
The CPU id to remove. | 9.362766 | 9.836356 | 0.951853 |
if not isinstance(cpu, baseinteger):
raise TypeError("cpu can only be an instance of type baseinteger")
attached = self._call("getCPUStatus",
in_p=[cpu])
return attached | def get_cpu_status(self, cpu) | Returns the current status of the given CPU.
in cpu of type int
The CPU id to check for.
return attached of type bool
Status of the CPU. | 11.954528 | 10.532749 | 1.134986 |
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
filename = self._call("queryLogFilename",
in_p=[idx])
return filename | def query_log_filename(self, idx) | Queries for the VM log file name of an given index. Returns an empty
string if a log file with that index doesn't exists.
in idx of type int
Which log file name to query. 0=current log file.
return filename of type str
On return the full path to the log file or an empty... | 9.576862 | 9.960783 | 0.961457 |
if not isinstance(idx, baseinteger):
raise TypeError("idx can only be an instance of type baseinteger")
if not isinstance(offset, baseinteger):
raise TypeError("offset can only be an instance of type baseinteger")
if not isinstance(size, baseinteger):
... | def read_log(self, idx, offset, size) | Reads the VM log file. The chunk size is limited, so even if you
ask for a big piece there might be less data returned.
in idx of type int
Which log file to read. 0=current log file.
in offset of type int
Offset in the log file.
in size of type int
... | 3.014772 | 3.061024 | 0.98489 |
if not isinstance(target, IMachine):
raise TypeError("target can only be an instance of type IMachine")
if not isinstance(mode, CloneMode):
raise TypeError("mode can only be an instance of type CloneMode")
if not isinstance(options, list):
raise TypeE... | def clone_to(self, target, mode, options) | Creates a clone of this machine, either as a full clone (which means
creating independent copies of the hard disk media, save states and so
on), or as a linked clone (which uses its own differencing media,
sharing the parent media with the source machine).
The target machine obj... | 3.906193 | 3.194535 | 1.222773 |
if not isinstance(folder, basestring):
raise TypeError("folder can only be an instance of type basestring")
if not isinstance(type_p, basestring):
raise TypeError("type_p can only be an instance of type basestring")
progress = self._call("moveTo",
... | def move_to(self, folder, type_p) | Move machine on to new place/folder
in folder of type str
Target folder where machine is moved.
in type_p of type str
Type of moving.
Possible values:
basic - Only the files which belong solely to this machine
are moved from the original mach... | 4.09524 | 3.455191 | 1.185243 |
if not isinstance(saved_state_file, basestring):
raise TypeError("saved_state_file can only be an instance of type basestring")
self._call("adoptSavedState",
in_p=[saved_state_file]) | def adopt_saved_state(self, saved_state_file) | Associates the given saved state file to the virtual machine.
On success, the machine will go to the Saved state. Next time it is
powered up, it will be restored from the adopted saved state and
continue execution from the place where the saved state file was
created.
... | 4.763161 | 5.520468 | 0.862818 |
if not isinstance(f_remove_file, bool):
raise TypeError("f_remove_file can only be an instance of type bool")
self._call("discardSavedState",
in_p=[f_remove_file]) | def discard_saved_state(self, f_remove_file) | Forcibly resets the machine to "Powered Off" state if it is
currently in the "Saved" state (previously created by :py:func:`save_state` ).
Next time the machine is powered up, a clean boot will occur.
This operation is equivalent to resetting or powering off
the machine without ... | 5.788753 | 5.470035 | 1.058266 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
if not isinstance(description, basestring):
raise TypeError("description can only be an instance of type basestring")
if not isinstance(pause, bool):
... | def take_snapshot(self, name, description, pause) | Saves the current execution state
and all settings of the machine and creates differencing images
for all normal (non-independent) media.
See :py:class:`ISnapshot` for an introduction to snapshots.
This method can be called for a PoweredOff, Saved (see
:py:func:`save_st... | 3.080501 | 2.483991 | 1.240142 |
if not isinstance(start_id, basestring):
raise TypeError("start_id can only be an instance of type basestring")
if not isinstance(end_id, basestring):
raise TypeError("end_id can only be an instance of type basestring")
progress = self._call("deleteSnapshotRange"... | def delete_snapshot_range(self, start_id, end_id) | Starts deleting the specified snapshot range. This is limited to
linear snapshot lists, which means there may not be any other child
snapshots other than the direct sequence between the start and end
snapshot. If the start and end snapshot point to the same snapshot this
method is comple... | 3.449522 | 2.885504 | 1.195466 |
if not isinstance(snapshot, ISnapshot):
raise TypeError("snapshot can only be an instance of type ISnapshot")
progress = self._call("restoreSnapshot",
in_p=[snapshot])
progress = IProgress(progress)
return progress | def restore_snapshot(self, snapshot) | Starts resetting the machine's current state to the state contained
in the given snapshot, asynchronously. All current settings of the
machine will be reset and changes stored in differencing media
will be lost.
See :py:class:`ISnapshot` for an introduction to snapshots.
... | 8.603724 | 7.508928 | 1.145799 |
if not isinstance(flags, basestring):
raise TypeError("flags can only be an instance of type basestring")
self._call("applyDefaults",
in_p=[flags]) | def apply_defaults(self, flags) | Applies the defaults for the configured guest OS type. This is
primarily for getting sane settings straight after creating a
new VM, but it can also be applied later.
This is primarily a shortcut, centralizing the tedious job of
getting the recommended settings and tran... | 9.004826 | 8.542028 | 1.054179 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(settings, basestring):
raise TypeError("settings can only be an instance of type basestring")
self._call("webcamAttach",
... | def webcam_attach(self, path, settings) | Attaches the emulated USB webcam to the VM, which will use a host video capture device.
in path of type str
The host path of the capture device to use.
in settings of type str
Optional settings. | 3.807148 | 4.258709 | 0.893967 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
self._call("webcamDetach",
in_p=[path]) | def webcam_detach(self, path) | Detaches the emulated USB webcam from the VM
in path of type str
The host path of the capture device to detach. | 7.5089 | 8.767314 | 0.856465 |
if not isinstance(type_p, list):
raise TypeError("type_p can only be an instance of type list")
for a in type_p[:10]:
if not isinstance(a, DeviceType):
raise TypeError(
"array can only contain objects of type DeviceType")
a... | def get_device_activity(self, type_p) | Gets the current activity type of given devices or device groups.
in type_p of type :class:`DeviceType`
return activity of type :class:`DeviceActivity`
raises :class:`OleErrorInvalidarg`
Invalid device type. | 4.644701 | 4.184432 | 1.109996 |
if not isinstance(hostname, basestring):
raise TypeError("hostname can only be an instance of type basestring")
if not isinstance(tcpport, baseinteger):
raise TypeError("tcpport can only be an instance of type baseinteger")
if not isinstance(password, basestring)... | def teleport(self, hostname, tcpport, password, max_downtime) | Teleport the VM to a different host machine or process.
@todo Explain the details.
in hostname of type str
The name or IP of the host to teleport to.
in tcpport of type int
The TCP port to connect to (1..65535).
in password of type str
The ... | 2.25314 | 2.060365 | 1.093564 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(password, basestring):
raise TypeError("password can only be an instance of type basestring")
if not isinstance(clear_on_suspend, bool):
... | def add_disk_encryption_password(self, id_p, password, clear_on_suspend) | Adds a password used for hard disk encryption/decryption.
in id_p of type str
The identifier used for the password. Must match the identifier
used when the encrypted medium was created.
in password of type str
The password.
in clear_on_suspend of type bool
... | 2.108211 | 2.021434 | 1.042928 |
if not isinstance(ids, list):
raise TypeError("ids can only be an instance of type list")
for a in ids[:10]:
if not isinstance(a, basestring):
raise TypeError(
"array can only contain objects of type basestring")
if not isi... | def add_disk_encryption_passwords(self, ids, passwords, clear_on_suspend) | Adds a password used for hard disk encryption/decryption.
in ids of type str
List of identifiers for the passwords. Must match the identifier
used when the encrypted medium was created.
in passwords of type str
List of passwords.
in clear_on_suspend of type... | 2.385911 | 2.212893 | 1.078186 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
self._call("removeDiskEncryptionPassword",
in_p=[id_p]) | def remove_disk_encryption_password(self, id_p) | Removes a password used for hard disk encryption/decryption from
the running VM. As soon as the medium requiring this password
is accessed the VM is paused with an error and the password must be
provided again.
in id_p of type str
The identifier used for the password. Must m... | 5.481488 | 6.26027 | 0.875599 |
if not isinstance(ip_address, basestring):
raise TypeError("ip_address can only be an instance of type basestring")
if not isinstance(network_mask, basestring):
raise TypeError("network_mask can only be an instance of type basestring")
self._call("enableStaticIPC... | def enable_static_ip_config(self, ip_address, network_mask) | sets and enables the static IP V4 configuration for the given interface.
in ip_address of type str
IP address.
in network_mask of type str
network mask. | 2.873437 | 3.048534 | 0.942563 |
if not isinstance(ipv6_address, basestring):
raise TypeError("ipv6_address can only be an instance of type basestring")
if not isinstance(ipv6_network_mask_prefix_length, baseinteger):
raise TypeError("ipv6_network_mask_prefix_length can only be an instance of type basei... | def enable_static_ip_config_v6(self, ipv6_address, ipv6_network_mask_prefix_length) | sets and enables the static IP V6 configuration for the given interface.
in ipv6_address of type str
IP address.
in ipv6_network_mask_prefix_length of type int
network mask. | 2.554746 | 2.677609 | 0.954114 |
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
speed = self._call("getProcessorSpeed",
in_p=[cpu_id])
return speed | def get_processor_speed(self, cpu_id) | Query the (approximate) maximum speed of a specified host CPU in
Megahertz.
in cpu_id of type int
Identifier of the CPU.
return speed of type int
Speed value. 0 is returned if value is not known or @a cpuId is
invalid. | 6.698882 | 8.438452 | 0.793852 |
if not isinstance(feature, ProcessorFeature):
raise TypeError("feature can only be an instance of type ProcessorFeature")
supported = self._call("getProcessorFeature",
in_p=[feature])
return supported | def get_processor_feature(self, feature) | Query whether a CPU feature is supported or not.
in feature of type :class:`ProcessorFeature`
CPU Feature identifier.
return supported of type bool
Feature is supported or not. | 9.033183 | 6.941356 | 1.301357 |
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
description = self._call("getProcessorDescription",
in_p=[cpu_id])
return description | def get_processor_description(self, cpu_id) | Query the model string of a specified host CPU.
in cpu_id of type int
Identifier of the CPU.
The current implementation might not necessarily return the
description for this exact CPU.
return description of type str
Model string. An empty st... | 6.530827 | 7.44569 | 0.877129 |
if not isinstance(cpu_id, baseinteger):
raise TypeError("cpu_id can only be an instance of type baseinteger")
if not isinstance(leaf, baseinteger):
raise TypeError("leaf can only be an instance of type baseinteger")
if not isinstance(sub_leaf, baseinteger):
... | def get_processor_cpuid_leaf(self, cpu_id, leaf, sub_leaf) | Returns the CPU cpuid information for the specified leaf.
in cpu_id of type int
Identifier of the CPU. The CPU most be online.
The current implementation might not necessarily return the
description for this exact CPU.
in leaf of type int
CP... | 2.491666 | 2.233625 | 1.115525 |
(progress, host_interface) = self._call("createHostOnlyNetworkInterface")
progress = IProgress(progress)
host_interface = IHostNetworkInterface(host_interface)
return (progress, host_interface) | def create_host_only_network_interface(self) | Creates a new adapter for Host Only Networking.
out host_interface of type :class:`IHostNetworkInterface`
Created host interface object.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`OleErrorInvalidarg`
... | 6.213724 | 4.271232 | 1.454785 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
progress = self._call("removeHostOnlyNetworkInterface",
in_p=[id_p])
progress = IProgress(progress)
return progress | def remove_host_only_network_interface(self, id_p) | Removes the given Host Only Networking interface.
in id_p of type str
Adapter GUID.
return progress of type :class:`IProgress`
Progress object to track the operation completion.
raises :class:`VBoxErrorObjectNotFound`
No host network interface matching @a i... | 6.119664 | 4.65029 | 1.315975 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
filter_p = self._call("createUSBDeviceFilter",
in_p=[name])
filter_p = IHostUSBDeviceFilter(filter_p)
return filter_p | def create_usb_device_filter(self, name) | Creates a new USB device filter. All attributes except
the filter name are set to empty (any match),
*active* is @c false (the filter is not active).
The created filter can be added to the list of filters using
:py:func:`insert_usb_device_filter` .
:py:func:`usb... | 5.986421 | 4.83872 | 1.237191 |
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
if not isinstance(filter_p, IHostUSBDeviceFilter):
raise TypeError("filter_p can only be an instance of type IHostUSBDeviceFilter")
self._call("inser... | def insert_usb_device_filter(self, position, filter_p) | Inserts the given USB device to the specified position
in the list of filters.
Positions are numbered starting from @c 0. If the specified
position is equal to or greater than the number of elements in
the list, the filter is added at the end of the collection.
... | 4.047463 | 3.187655 | 1.26973 |
if not isinstance(position, baseinteger):
raise TypeError("position can only be an instance of type baseinteger")
self._call("removeUSBDeviceFilter",
in_p=[position]) | def remove_usb_device_filter(self, position) | Removes a USB device filter from the specified position in the
list of filters.
Positions are numbered starting from @c 0. Specifying a
position equal to or greater than the number of elements in
the list will produce an error.
If USB functionality is n... | 9.147969 | 9.643466 | 0.948618 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
drive = self._call("findHostDVDDrive",
in_p=[name])
drive = IMedium(drive)
return drive | def find_host_dvd_drive(self, name) | Searches for a host DVD drive with the given @c name.
in name of type str
Name of the host drive to search for
return drive of type :class:`IMedium`
Found host drive object
raises :class:`VBoxErrorObjectNotFound`
Given @c name does not correspond to any hos... | 7.752208 | 5.941812 | 1.304688 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
network_interface = self._call("findHostNetworkInterfaceByName",
in_p=[name])
network_interface = IHostNetworkInterface(network_interface)
ret... | def find_host_network_interface_by_name(self, name) | Searches through all host network interfaces for an interface with
the given @c name.
The method returns an error if the given @c name does not
correspond to any host network interface.
in name of type str
Name of the host network interface to search for.
r... | 5.010716 | 4.911159 | 1.020272 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
network_interface = self._call("findHostNetworkInterfaceById",
in_p=[id_p])
network_interface = IHostNetworkInterface(network_interface)
retur... | def find_host_network_interface_by_id(self, id_p) | Searches through all host network interfaces for an interface with
the given GUID.
The method returns an error if the given GUID does not
correspond to any host network interface.
in id_p of type str
GUID of the host network interface to search for.
return ... | 4.327981 | 3.844327 | 1.12581 |
if not isinstance(type_p, HostNetworkInterfaceType):
raise TypeError("type_p can only be an instance of type HostNetworkInterfaceType")
network_interfaces = self._call("findHostNetworkInterfacesOfType",
in_p=[type_p])
network_interfaces = [IHostNetworkIn... | def find_host_network_interfaces_of_type(self, type_p) | Searches through all host network interfaces and returns a list of interfaces of the specified type
in type_p of type :class:`HostNetworkInterfaceType`
type of the host network interfaces to search for.
return network_interfaces of type :class:`IHostNetworkInterface`
Found host... | 4.01382 | 3.455351 | 1.161625 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
device = self._call("findUSBDeviceById",
in_p=[id_p])
device = IHostUSBDevice(device)
return device | def find_usb_device_by_id(self, id_p) | Searches for a USB device with the given UUID.
:py:func:`IUSBDevice.id_p`
in id_p of type str
UUID of the USB device to search for.
return device of type :class:`IHostUSBDevice`
Found USB device object.
raises :class:`VBoxErrorObject... | 6.029096 | 4.282079 | 1.407983 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
device = self._call("findUSBDeviceByAddress",
in_p=[name])
device = IHostUSBDevice(device)
return device | def find_usb_device_by_address(self, name) | Searches for a USB device with the given host address.
:py:func:`IUSBDevice.address`
in name of type str
Address of the USB device (as assigned by the host) to
search for.
return device of type :class:`IHostUSBDevice`
Found USB de... | 7.444937 | 5.250297 | 1.418003 |
if not isinstance(backend, basestring):
raise TypeError("backend can only be an instance of type basestring")
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
if not isinstance(address, basestring):
... | def add_usb_device_source(self, backend, id_p, address, property_names, property_values) | Adds a new USB device source.
in backend of type str
The backend to use as the new device source.
in id_p of type str
Unique ID to identify the source.
in address of type str
Address to use, the format is dependent on the backend.
For USB/IP bac... | 1.848406 | 1.840325 | 1.004391 |
if not isinstance(id_p, basestring):
raise TypeError("id_p can only be an instance of type basestring")
self._call("removeUSBDeviceSource",
in_p=[id_p]) | def remove_usb_device_source(self, id_p) | Removes a previously added USB device source.
in id_p of type str
The identifier used when the source was added. | 5.321733 | 5.351196 | 0.994494 |
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
max_network_adapters = self._call("getMaxNetworkAdapters",
in_p=[chipset])
return max_network_adapters | def get_max_network_adapters(self, chipset) | Maximum total number of network adapters associated with every
:py:class:`IMachine` instance.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
return max_network_adapters of type int
The maximum total number of network adapters allowed. | 5.299157 | 4.985713 | 1.062869 |
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(type_p, NetworkAttachmentType):
raise TypeError("type_p can only be an instance of type NetworkAttachmentType")
max_network_adapters ... | def get_max_network_adapters_of_type(self, chipset, type_p) | Maximum number of network adapters of a given attachment type,
associated with every :py:class:`IMachine` instance.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
in type_p of type :class:`NetworkAttachmentType`
Type of attachment.
... | 3.122855 | 2.558384 | 1.220636 |
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_devices_per_port = self._call("getMaxDevicesPerPortForStorageBus",
in_p=[bus])
return max_devices_per_port | def get_max_devices_per_port_for_storage_bus(self, bus) | Returns the maximum number of devices which can be attached to a port
for the given storage bus.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return max_devices_per_port of type int
The maximum number of devices which can be attached to ... | 4.813388 | 4.892485 | 0.983833 |
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
min_port_count = self._call("getMinPortCountForStorageBus",
in_p=[bus])
return min_port_count | def get_min_port_count_for_storage_bus(self, bus) | Returns the minimum number of ports the given storage bus supports.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return min_port_count of type int
The minimum number of ports for the given storage bus. | 5.673717 | 5.356169 | 1.059286 |
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_port_count = self._call("getMaxPortCountForStorageBus",
in_p=[bus])
return max_port_count | def get_max_port_count_for_storage_bus(self, bus) | Returns the maximum number of ports the given storage bus supports.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return max_port_count of type int
The maximum number of ports for the given storage bus. | 5.650432 | 5.500887 | 1.027186 |
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
max_instances = self._call("getMaxInstancesOfStor... | def get_max_instances_of_storage_bus(self, chipset, bus) | Returns the maximum number of storage bus instances which
can be configured for each VM. This corresponds to the number of
storage controllers one can have. Value may depend on chipset type
used.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
... | 3.550557 | 3.037767 | 1.168805 |
if not isinstance(bus, StorageBus):
raise TypeError("bus can only be an instance of type StorageBus")
device_types = self._call("getDeviceTypesForStorageBus",
in_p=[bus])
device_types = [DeviceType(a) for a in device_types]
return device_types | def get_device_types_for_storage_bus(self, bus) | Returns list of all the supported device types
(:py:class:`DeviceType` ) for the given type of storage
bus.
in bus of type :class:`StorageBus`
The storage bus type to get the value for.
return device_types of type :class:`DeviceType`
The list of all supported de... | 4.464335 | 4.259328 | 1.048131 |
if not isinstance(controller_type, StorageControllerType):
raise TypeError("controller_type can only be an instance of type StorageControllerType")
enabled = self._call("getDefaultIoCacheSettingForStorageController",
in_p=[controller_type])
return enable... | def get_default_io_cache_setting_for_storage_controller(self, controller_type) | Returns the default I/O cache setting for the
given storage controller
in controller_type of type :class:`StorageControllerType`
The storage controller type to get the setting for.
return enabled of type bool
Returned flag indicating the default value | 5.888611 | 5.780557 | 1.018693 |
if not isinstance(controller_type, StorageControllerType):
raise TypeError("controller_type can only be an instance of type StorageControllerType")
hotplug_capable = self._call("getStorageControllerHotplugCapable",
in_p=[controller_type])
return hotplug_... | def get_storage_controller_hotplug_capable(self, controller_type) | Returns whether the given storage controller supports
hot-plugging devices.
in controller_type of type :class:`StorageControllerType`
The storage controller to check the setting for.
return hotplug_capable of type bool
Returned flag indicating whether the controller is ... | 4.147621 | 4.258039 | 0.974068 |
if not isinstance(chipset, ChipsetType):
raise TypeError("chipset can only be an instance of type ChipsetType")
if not isinstance(type_p, USBControllerType):
raise TypeError("type_p can only be an instance of type USBControllerType")
max_instances = self._call("g... | def get_max_instances_of_usb_controller_type(self, chipset, type_p) | Returns the maximum number of USB controller instances which
can be configured for each VM. This corresponds to the number of
USB controllers one can have. Value may depend on chipset type
used.
in chipset of type :class:`ChipsetType`
The chipset type to get the value for.
... | 2.899028 | 2.569055 | 1.128442 |
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
supported = self._call("isFormatSupported",
in_p=[format_p])
return supported | def is_format_supported(self, format_p) | Checks if a specific drag'n drop MIME / Content-type format is supported.
in format_p of type str
Format to check for.
return supported of type bool
Returns @c true if the specified format is supported, @c false if not. | 5.456149 | 4.936125 | 1.105351 |
if not isinstance(formats, list):
raise TypeError("formats can only be an instance of type list")
for a in formats[:10]:
if not isinstance(a, basestring):
raise TypeError(
"array can only contain objects of type basestring")
... | def add_formats(self, formats) | Adds MIME / Content-type formats to the supported formats.
in formats of type str
Collection of formats to add. | 6.87089 | 6.606388 | 1.040037 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
(default_action, formats, allowed_actions) = self._call("dragIsPending",
in_p=[screen_id])
default_action = DnDAction(default_action)
... | def drag_is_pending(self, screen_id) | Ask the source if there is any drag and drop operation pending.
If no drag and drop operation is pending currently, DnDAction_Ignore is returned.
in screen_id of type int
The screen ID where the drag and drop event occurred.
out formats of type str
On return the support... | 5.206926 | 3.295645 | 1.579941 |
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(action, DnDAction):
raise TypeError("action can only be an instance of type DnDAction")
progress = self._call("drop",
... | def drop(self, format_p, action) | Informs the source that a drop event occurred for a pending
drag and drop operation.
in format_p of type str
The mime type the data must be in.
in action of type :class:`DnDAction`
The action to use.
return progress of type :class:`IProgress`
Progre... | 4.21949 | 3.011417 | 1.401164 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(y, baseinteger):
raise TypeError("y can only be an instance of type baseinteger")
if not isinstance(x, baseinteger):
... | def enter(self, screen_id, y, x, default_action, allowed_actions, formats) | Informs the target about a drag and drop enter event.
in screen_id of type int
The screen ID where the drag and drop event occurred.
in y of type int
Y-position of the event.
in x of type int
X-position of the event.
in default_action of type :clas... | 1.977234 | 1.794263 | 1.101976 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
self._call("leave",
in_p=[screen_id]) | def leave(self, screen_id) | Informs the target about a drag and drop leave event.
in screen_id of type int
The screen ID where the drag and drop event occurred.
raises :class:`VBoxErrorVmError`
VMM device is not available. | 8.515008 | 8.733592 | 0.974972 |
if not isinstance(screen_id, baseinteger):
raise TypeError("screen_id can only be an instance of type baseinteger")
if not isinstance(format_p, basestring):
raise TypeError("format_p can only be an instance of type basestring")
if not isinstance(data, list):
... | def send_data(self, screen_id, format_p, data) | Initiates sending data to the target.
in screen_id of type int
The screen ID where the drag and drop event occurred.
in format_p of type str
The MIME type the data is in.
in data of type str
The actual data.
return progress of type :class:`IProgres... | 3.277519 | 2.863962 | 1.1444 |
if not isinstance(sources, list):
raise TypeError("sources can only be an instance of type list")
for a in sources[:10]:
if not isinstance(a, basestring):
raise TypeError(
"array can only contain objects of type basestring")
... | def copy_from_guest(self, sources, filters, flags, destination) | Copies directories and/or files from guest to the host.
This function requires several parallel arrays to be supplied, one
set for each source.
in sources of type str
Paths to directories and/or files on the guest side that should be
copied to the host. If the p... | 2.217199 | 2.037433 | 1.088231 |
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
... | def directory_copy(self, source, destination, flags) | Recursively copies a directory from one guest location to another.
in source of type str
The path to the directory to copy (in the guest). Guest path style.
in destination of type str
The path to the target directory (in the guest). Unless the
:py:attr:`DirectoryC... | 3.591397 | 2.963048 | 1.212062 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(flags, list):
raise Typ... | def directory_create(self, path, mode, flags) | Creates a directory in the guest.
in path of type str
Path to the directory directory to be created. Guest path style.
in mode of type int
The UNIX-style access mode mask to create the directory with.
Whether/how all three access groups and associated access rights ... | 3.552413 | 3.00799 | 1.180992 |
if not isinstance(template_name, basestring):
raise TypeError("template_name can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(path, basestring)... | def directory_create_temp(self, template_name, mode, path, secure) | Creates a temporary directory in the guest.
in template_name of type str
Template for the name of the directory to create. This must
contain at least one 'X' character. The first group of consecutive
'X' characters in the template will be replaced by a random
alp... | 2.35752 | 2.156047 | 1.093446 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(filter_p, basestring):
raise TypeError("filter_p can only be an instance of type basestring")
if not isinstance(flags, list):
rai... | def directory_open(self, path, filter_p, flags) | Opens a directory in the guest and creates a :py:class:`IGuestDirectory`
object that can be used for further operations.
This method follows symbolic links by default at the moment, this
may change in the future.
in path of type str
Path to the directory to open. G... | 3.618554 | 2.695287 | 1.342548 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
self._call("directoryRemove",
in_p=[path]) | def directory_remove(self, path) | Removes a guest directory if empty.
Symbolic links in the final component will not be followed,
instead an not-a-directory error is reported.
in path of type str
Path to the directory that should be removed. Guest path style. | 8.120615 | 9.194621 | 0.883192 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(flags, list):
raise TypeError("flags can only be an instance of type list")
for a in flags[:10]:
if not isinstance(a, DirectoryRe... | def directory_remove_recursive(self, path, flags) | Removes a guest directory recursively.
<!-- Add this back when the warning can be removed:
Unless :py:attr:`DirectoryRemoveRecFlag.content_and_dir` or
:py:attr:`DirectoryRemoveRecFlag.content_only` is given, only the
directory structure is removed. Which means it will fail i... | 4.976549 | 3.784875 | 1.314852 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
self._call("environmentScheduleUnset",
in_p=[name]) | def environment_schedule_unset(self, name) | Schedules unsetting (removing) an environment variable when creating
the next guest process. This affects the
:py:func:`IGuestSession.environment_changes` attribute.
in name of type str
Name of the environment variable to unset. This cannot be empty
nor can it contain... | 7.736757 | 8.940742 | 0.865337 |
if not isinstance(name, basestring):
raise TypeError("name can only be an instance of type basestring")
exists = self._call("environmentDoesBaseVariableExist",
in_p=[name])
return exists | def environment_does_base_variable_exist(self, name) | Checks if the given environment variable exists in the session's base
environment (:py:func:`IGuestSession.environment_base` ).
in name of type str
Name of the environment variable to look for. This cannot be
empty nor can it contain any equal signs.
return exists of t... | 6.991362 | 6.514722 | 1.073164 |
if not isinstance(source, basestring):
raise TypeError("source can only be an instance of type basestring")
if not isinstance(destination, basestring):
raise TypeError("destination can only be an instance of type basestring")
if not isinstance(flags, list):
... | def file_copy(self, source, destination, flags) | Copies a file from one guest location to another.
Will overwrite the destination file unless
:py:attr:`FileCopyFlag.no_replace` is specified.
in source of type str
The path to the file to copy (in the guest). Guest path style.
in destination of type str
... | 3.588861 | 2.965721 | 1.210114 |
if not isinstance(template_name, basestring):
raise TypeError("template_name can only be an instance of type basestring")
if not isinstance(mode, baseinteger):
raise TypeError("mode can only be an instance of type baseinteger")
if not isinstance(path, basestring)... | def file_create_temp(self, template_name, mode, path, secure) | Creates a temporary file in the guest.
in template_name of type str
Template for the name of the file to create. This must contain
at least one 'X' character. The first group of consecutive 'X'
characters in the template will be replaced by a random
alphanumeric ... | 2.570411 | 2.043091 | 1.258099 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(access_mode, FileAccessMode):
raise TypeError("access_mode can only be an instance of type FileAccessMode")
if not isinstance(open_action, Fi... | def file_open(self, path, access_mode, open_action, creation_mode) | Opens a file and creates a :py:class:`IGuestFile` object that
can be used for further operations.
in path of type str
Path to file to open. Guest path style.
in access_mode of type :class:`FileAccessMode`
The file access mode (read, write and/or append).
S... | 2.555708 | 1.978316 | 1.29186 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(access_mode, FileAccessMode):
raise TypeError("access_mode can only be an instance of type FileAccessMode")
if not isinstance(open_action, Fi... | def file_open_ex(self, path, access_mode, open_action, sharing_mode, creation_mode, flags) | Opens a file and creates a :py:class:`IGuestFile` object that
can be used for further operations, extended version.
in path of type str
Path to file to open. Guest path style.
in access_mode of type :class:`FileAccessMode`
The file access mode (read, write and/or appe... | 2.335202 | 1.865934 | 1.251492 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
size = self._call("fileQuerySize",
... | def file_query_size(self, path, follow_symlinks) | Queries the size of a regular file in the guest.
in path of type str
Path to the file which size is requested. Guest path style.
in follow_symlinks of type bool
It @c true, symbolic links in the final path component will be
followed to their target, and the size of... | 3.3271 | 3.283251 | 1.013355 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
exists = self._call("fsObjExists",
... | def fs_obj_exists(self, path, follow_symlinks) | Checks whether a file system object (file, directory, etc) exists in
the guest or not.
in path of type str
Path to the file system object to check the existance of. Guest
path style.
in follow_symlinks of type bool
If @c true, symbolic links in the final co... | 3.240241 | 3.139723 | 1.032015 |
if not isinstance(path, basestring):
raise TypeError("path can only be an instance of type basestring")
if not isinstance(follow_symlinks, bool):
raise TypeError("follow_symlinks can only be an instance of type bool")
info = self._call("fsObjQueryInfo",
... | def fs_obj_query_info(self, path, follow_symlinks) | Queries information about a file system object (file, directory, etc)
in the guest.
in path of type str
Path to the file system object to gather information about.
Guest path style.
in follow_symlinks of type bool
Information about symbolic links is returned... | 3.816747 | 2.966061 | 1.286807 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.