code
string
signature
string
docstring
string
loss_without_docstring
float64
loss_with_docstring
float64
factor
float64
if not isinstance(path, basestring): raise TypeError("path can only be an instance of type basestring") self._call("fsObjRemove", in_p=[path])
def fs_obj_remove(self, path)
Removes a file system object (file, symlink, etc) in the guest. Will not work on directories, use :py:func:`IGuestSession.directory_remove` to remove directories. This method will remove symbolic links in the final path component, not follow them. in path of type str ...
7.547235
8.796823
0.85795
if not isinstance(path, list): raise TypeError("path can only be an instance of type list") for a in path[:10]: if not isinstance(a, basestring): raise TypeError( "array can only contain objects of type basestring") progres...
def fs_obj_remove_array(self, path)
Removes multiple file system objects (files, directories, symlinks, etc) in the guest. Use with caution. This method is not implemented yet and will return E_NOTIMPL. This method will remove symbolic links in the final path component, not follow them. in path o...
7.219222
5.275168
1.368529
if not isinstance(old_path, basestring): raise TypeError("old_path can only be an instance of type basestring") if not isinstance(new_path, basestring): raise TypeError("new_path can only be an instance of type basestring") if not isinstance(flags, list): ...
def fs_obj_rename(self, old_path, new_path, flags)
Renames a file system object (file, directory, symlink, etc) in the guest. in old_path of type str The current path to the object. Guest path style. in new_path of type str The new path to the object. Guest path style. in flags of type :class:`FsObjRenameFlag...
3.028518
2.61795
1.156828
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 fs_obj_move(self, source, destination, flags)
Moves a file system object (file, directory, symlink, etc) from one guest location to another. This differs from :py:func:`IGuestSession.fs_obj_rename` in that it can move accross file system boundraries. In that case it will perform a copy and then delete the original. For d...
3.696446
2.889552
1.279245
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") if not isinstance(acl, basestring): ...
def fs_obj_set_acl(self, path, follow_symlinks, acl, mode)
Sets the access control list (ACL) of a file system object (file, directory, etc) in the guest. in path of type str Full path of the file system object which ACL to set in follow_symlinks of type bool If @c true symbolic links in the final component will be followed, ...
2.165426
2.174786
0.995696
if not isinstance(executable, basestring): raise TypeError("executable can only be an instance of type basestring") if not isinstance(arguments, list): raise TypeError("arguments can only be an instance of type list") for a in arguments[:10]: if not i...
def process_create(self, executable, arguments, environment_changes, flags, timeout_ms)
Creates a new process running in the guest. The new process will be started asynchronously, meaning on return of this function it is not be guaranteed that the guest process is in a started state. To wait for successful startup, use the :py:func:`IProcess.wait_for` call. ...
2.071008
1.851865
1.118336
if not isinstance(executable, basestring): raise TypeError("executable can only be an instance of type basestring") if not isinstance(arguments, list): raise TypeError("arguments can only be an instance of type list") for a in arguments[:10]: if not i...
def process_create_ex(self, executable, arguments, environment_changes, flags, timeout_ms, priority, affinity)
Creates a new process running in the guest with the extended options for setting the process priority and affinity. See :py:func:`IGuestSession.process_create` for more information. in executable of type str Full path to the file to execute in the guest. The file has to ...
1.784749
1.656026
1.07773
if not isinstance(pid, baseinteger): raise TypeError("pid can only be an instance of type baseinteger") guest_process = self._call("processGet", in_p=[pid]) guest_process = IGuestProcess(guest_process) return guest_process
def process_get(self, pid)
Gets a certain guest process by its process ID (PID). in pid of type int Process ID (PID) to get guest process for. return guest_process of type :class:`IGuestProcess` Guest process of specified process ID (PID).
8.712053
5.697759
1.529032
if not isinstance(symlink, basestring): raise TypeError("symlink can only be an instance of type basestring") if not isinstance(target, basestring): raise TypeError("target can only be an instance of type basestring") if not isinstance(type_p, SymlinkType): ...
def symlink_create(self, symlink, target, type_p)
Creates a symbolic link in the guest. in symlink of type str Path to the symbolic link that should be created. Guest path style. in target of type str The path to the symbolic link target. If not an absolute, this will be relative to the @a symlink loc...
2.556216
2.401777
1.064302
if not isinstance(symlink, basestring): raise TypeError("symlink can only be an instance of type basestring") exists = self._call("symlinkExists", in_p=[symlink]) return exists
def symlink_exists(self, symlink)
Checks whether a symbolic link exists in the guest. in symlink of type str Path to the alleged symbolic link. Guest path style. return exists of type bool Returns @c true if the symbolic link exists. Returns @c false if it does not exist, if the file system object...
8.530288
8.721642
0.97806
if not isinstance(symlink, basestring): raise TypeError("symlink 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, Symli...
def symlink_read(self, symlink, flags)
Reads the target value of a symbolic link in the guest. in symlink of type str Path to the symbolic link to read. in flags of type :class:`SymlinkReadFlag` Zero or more :py:class:`SymlinkReadFlag` values. return target of type str Target value of the symbo...
5.100526
4.139467
1.23217
if not isinstance(wait_for, list): raise TypeError("wait_for can only be an instance of type list") for a in wait_for[:10]: if not isinstance(a, GuestSessionWaitForFlag): raise TypeError( "array can only contain objects of type Gue...
def wait_for_array(self, wait_for, timeout_ms)
Waits for one or more events to happen. Scriptable version of :py:func:`wait_for` . in wait_for of type :class:`GuestSessionWaitForFlag` Specifies what to wait for; see :py:class:`GuestSessionWaitForFlag` for more information. in timeout_ms of type int Time...
4.968891
3.524997
1.409616
if not isinstance(wait_for, baseinteger): raise TypeError("wait_for can only be an instance of type baseinteger") if not isinstance(timeout_ms, baseinteger): raise TypeError("timeout_ms can only be an instance of type baseinteger") reason = self._call("waitFor", ...
def wait_for(self, wait_for, timeout_ms)
Waits for one or more events to happen. in wait_for of type int Specifies what to wait for; see :py:class:`ProcessWaitForFlag` for more information. in timeout_ms of type int Timeout (in ms) to wait for the operation to complete. Pass 0 for an infinite ...
4.691082
3.482924
1.34688
if not isinstance(wait_for, list): raise TypeError("wait_for can only be an instance of type list") for a in wait_for[:10]: if not isinstance(a, ProcessWaitForFlag): raise TypeError( "array can only contain objects of type ProcessW...
def wait_for_array(self, wait_for, timeout_ms)
Waits for one or more events to happen. Scriptable version of :py:func:`wait_for` . in wait_for of type :class:`ProcessWaitForFlag` Specifies what to wait for; see :py:class:`ProcessWaitForFlag` for more information. in timeout_ms of type int Timeout (in ms...
4.959809
3.699743
1.340582
if not isinstance(handle, baseinteger): raise TypeError("handle can only be an instance of type baseinteger") if not isinstance(flags, baseinteger): raise TypeError("flags can only be an instance of type baseinteger") if not isinstance(data, list): ra...
def write(self, handle, flags, data, timeout_ms)
Writes data to a running process. in handle of type int Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr. in flags of type int A combination of :py:class:`ProcessInputFlag` flags. in data of type str Array of bytes to write. The size of ...
2.709701
2.586809
1.047507
if not isinstance(to_read, baseinteger): raise TypeError("to_read can only be an instance of type baseinteger") if not isinstance(timeout_ms, baseinteger): raise TypeError("timeout_ms can only be an instance of type baseinteger") data = self._call("read", ...
def read(self, to_read, timeout_ms)
Reads data from this file. in to_read of type int Number of bytes to read. in timeout_ms of type int Timeout (in ms) to wait for the operation to complete. Pass 0 for an infinite timeout. return data of type str Array of data read. rais...
3.557179
3.709913
0.958831
if not isinstance(offset, baseinteger): raise TypeError("offset can only be an instance of type baseinteger") if not isinstance(to_read, baseinteger): raise TypeError("to_read can only be an instance of type baseinteger") if not isinstance(timeout_ms, baseinteger...
def read_at(self, offset, to_read, timeout_ms)
Reads data from an offset of this file. in offset of type int Offset in bytes to start reading. in to_read of type int Number of bytes to read. in timeout_ms of type int Timeout (in ms) to wait for the operation to complete. Pass 0 for an infini...
2.647467
2.693343
0.982967
if not isinstance(offset, baseinteger): raise TypeError("offset can only be an instance of type baseinteger") if not isinstance(whence, FileSeekOrigin): raise TypeError("whence can only be an instance of type FileSeekOrigin") new_offset = self._call("seek", ...
def seek(self, offset, whence)
Changes the current file position of this file. The file current position always applies to the :py:func:`IFile.read` method. Same for the :py:func:`IFile.write` method it except when the :py:func:`IFile.access_mode` is :py:attr:`FileAccessMode.append_only` or :py:attr:`Fil...
4.78528
3.800514
1.259114
if not isinstance(acl, basestring): raise TypeError("acl can only be an instance of type basestring") if not isinstance(mode, baseinteger): raise TypeError("mode can only be an instance of type baseinteger") self._call("setACL", in_p=[acl, mo...
def set_acl(self, acl, mode)
Sets the ACL of this file. in acl of type str The ACL specification string. To-be-defined. in mode of type int UNIX-style mode mask to use if @a acl is empty. As mention in :py:func:`IGuestSession.directory_create` this is realized on a best effort basi...
4.327756
4.104776
1.054322
if not isinstance(size, baseinteger): raise TypeError("size can only be an instance of type baseinteger") self._call("setSize", in_p=[size])
def set_size(self, size)
Changes the file size. in size of type int The new file size. raises :class:`OleErrorNotimpl` The method is not implemented yet.
11.762214
12.568666
0.935836
(cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared, mem_cache, paged_total, mem_alloc_total, mem_free_total, mem_balloon_total, mem_shared_total) = self._call("internalGetStatistics") return (cpu_user, cpu_kernel, cpu_idle, mem_total, mem_free, mem_balloon, mem_shared...
def internal_get_statistics(self)
Internal method; do not use as it might change at any time. out cpu_user of type int Percentage of processor time spent in user mode as seen by the guest. out cpu_kernel of type int Percentage of processor time spent in kernel mode as seen by the guest. out cpu_idle of...
2.611262
1.539134
1.696579
if not isinstance(facility, AdditionsFacilityType): raise TypeError("facility can only be an instance of type AdditionsFacilityType") (status, timestamp) = self._call("getFacilityStatus", in_p=[facility]) status = AdditionsFacilityStatus(status) ...
def get_facility_status(self, facility)
Get the current status of a Guest Additions facility. in facility of type :class:`AdditionsFacilityType` Facility to check status for. out timestamp of type int Timestamp (in ms) of last status update seen by the host. return status of type :class:`AdditionsFacilitySta...
7.27071
4.486103
1.620719
if not isinstance(level, AdditionsRunLevelType): raise TypeError("level can only be an instance of type AdditionsRunLevelType") active = self._call("getAdditionsStatus", in_p=[level]) return active
def get_additions_status(self, level)
Retrieve the current status of a certain Guest Additions run level. in level of type :class:`AdditionsRunLevelType` Status level to check return active of type bool Flag whether the status level has been reached or not raises :class:`VBoxErrorNotSupported` ...
10.055234
6.218299
1.617039
if not isinstance(user_name, basestring): raise TypeError("user_name 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(domain, basestring)...
def set_credentials(self, user_name, password, domain, allow_interactive_logon)
Store login credentials that can be queried by guest operating systems with Additions installed. The credentials are transient to the session and the guest may also choose to erase them. Note that the caller cannot determine whether the guest operating system has queried or made use of t...
1.861311
1.867694
0.996583
if not isinstance(user, basestring): raise TypeError("user 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(domain, basestring): ...
def create_session(self, user, password, domain, session_name)
Creates a new guest session for controlling the guest. The new session will be started asynchronously, meaning on return of this function it is not guaranteed that the guest session is in a started and/or usable state. To wait for successful startup, use the :py:func:`IGuestSession.wait_for` ...
2.149307
1.991935
1.079005
if not isinstance(session_name, basestring): raise TypeError("session_name can only be an instance of type basestring") sessions = self._call("findSession", in_p=[session_name]) sessions = [IGuestSession(a) for a in sessions] return sessions
def find_session(self, session_name)
Finds guest sessions by their friendly name and returns an interface array with all found guest sessions. in session_name of type str The session's friendly name to find. Wildcards like ? and * are allowed. return sessions of type :class:`IGuestSession` Array with all g...
6.187139
5.458243
1.13354
if not isinstance(source, basestring): raise TypeError("source can only be an instance of type basestring") if not isinstance(arguments, list): raise TypeError("arguments can only be an instance of type list") for a in arguments[:10]: if not isinstanc...
def update_guest_additions(self, source, arguments, flags)
Automatically updates already installed Guest Additions in a VM. At the moment only Windows guests are supported. Because the VirtualBox Guest Additions drivers are not WHQL-certified yet there might be warning dialogs during the actual Guest Additions update. These nee...
2.999032
2.589333
1.158226
if not isinstance(timeout, baseinteger): raise TypeError("timeout can only be an instance of type baseinteger") self._call("waitForCompletion", in_p=[timeout])
def wait_for_completion(self, timeout)
Waits until the task is done (including all sub-operations) with a given timeout in milliseconds; specify -1 for an indefinite wait. Note that the VirtualBox/XPCOM/COM/native event queues of the calling thread are not processed while waiting. Neglecting event queues may have dir...
11.234867
10.95267
1.025765
if not isinstance(operation, baseinteger): raise TypeError("operation can only be an instance of type baseinteger") if not isinstance(timeout, baseinteger): raise TypeError("timeout can only be an instance of type baseinteger") self._call("waitForOperationComplet...
def wait_for_operation_completion(self, operation, timeout)
Waits until the given operation is done with a given timeout in milliseconds; specify -1 for an indefinite wait. See :py:func:`wait_for_completion` for event queue considerations. in operation of type int Number of the operation to wait for. Must be less than :p...
4.521233
4.136988
1.09288
if not isinstance(percent, baseinteger): raise TypeError("percent can only be an instance of type baseinteger") self._call("setCurrentOperationProgress", in_p=[percent])
def set_current_operation_progress(self, percent)
Internal method, not to be called externally. in percent of type int
9.056495
8.918825
1.015436
if not isinstance(progress_other, IProgress): raise TypeError("progress_other can only be an instance of type IProgress") if not isinstance(timeout_ms, baseinteger): raise TypeError("timeout_ms can only be an instance of type baseinteger") self._call("waitForOthe...
def wait_for_other_progress_completion(self, progress_other, timeout_ms)
Internal method, not to be called externally. Waits until the other task is completed (including all sub-operations) and forward all changes from the other progress to this progress. This means sub-operation number, description, percent and so on. The caller is responsi...
4.044897
3.611898
1.119881
if not isinstance(next_operation_description, basestring): raise TypeError("next_operation_description can only be an instance of type basestring") if not isinstance(next_operations_weight, baseinteger): raise TypeError("next_operations_weight can only be an instance of ...
def set_next_operation(self, next_operation_description, next_operations_weight)
Internal method, not to be called externally. in next_operation_description of type str in next_operations_weight of type int
2.929483
3.034186
0.965492
if not isinstance(result_code, baseinteger): raise TypeError("result_code can only be an instance of type baseinteger") if not isinstance(error_info, IVirtualBoxErrorInfo): raise TypeError("error_info can only be an instance of type IVirtualBoxErrorInfo") self._c...
def notify_complete(self, result_code, error_info)
Internal method, not to be called externally. in result_code of type int in error_info of type :class:`IVirtualBoxErrorInfo`
4.253666
3.62536
1.173309
if not isinstance(set_image_id, bool): raise TypeError("set_image_id can only be an instance of type bool") if not isinstance(image_id, basestring): raise TypeError("image_id can only be an instance of type basestring") if not isinstance(set_parent_id, bool): ...
def set_ids(self, set_image_id, image_id, set_parent_id, parent_id)
Changes the UUID and parent UUID for a hard disk medium. in set_image_id of type bool Select whether a new image UUID is set or not. in image_id of type str New UUID for the image. If an empty string is passed, then a new UUID is automatically created, provided that...
1.846775
1.786066
1.03399
if not isinstance(machine_id, basestring): raise TypeError("machine_id can only be an instance of type basestring") snapshot_ids = self._call("getSnapshotIds", in_p=[machine_id]) return snapshot_ids
def get_snapshot_ids(self, machine_id)
Returns an array of UUIDs of all snapshots of the given machine where this medium is attached to. If the medium is attached to the machine in the current state, then the first element in the array will always be the ID of the queried machine (i.e. the value equal to the @c machi...
5.170814
5.582629
0.926233
if not isinstance(name, basestring): raise TypeError("name can only be an instance of type basestring") value = self._call("getProperty", in_p=[name]) return value
def get_property(self, name)
Returns the value of the custom medium property with the given name. The list of all properties supported by the given medium format can be obtained with :py:func:`IMediumFormat.describe_properties` . If this method returns an empty string in @a value, the requested pro...
8.338181
9.088393
0.917454
if not isinstance(name, basestring): raise TypeError("name 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("setProperty", in_p=[...
def set_property(self, name, value)
Sets the value of the custom medium property with the given name. The list of all properties supported by the given medium format can be obtained with :py:func:`IMediumFormat.describe_properties` . Setting the property value to @c null or an empty string is equivalent t...
3.919187
3.965477
0.988327
if not isinstance(names, basestring): raise TypeError("names can only be an instance of type basestring") (return_values, return_names) = self._call("getProperties", in_p=[names]) return (return_values, return_names)
def get_properties(self, names)
Returns values for a group of properties in one call. The names of the properties to get are specified using the @a names argument which is a list of comma-separated property names or an empty string if all properties are to be returned. Currently the value of this argument is i...
5.929605
6.071688
0.976599
if not isinstance(names, list): raise TypeError("names can only be an instance of type list") for a in names[:10]: if not isinstance(a, basestring): raise TypeError( "array can only contain objects of type basestring") if n...
def set_properties(self, names, values)
Sets values for a group of properties in one call. The names of the properties to set are passed in the @a names array along with the new values for them in the @a values array. Both arrays have the same number of elements with each element at the given index in the first array ...
3.02015
2.9383
1.027856
if not isinstance(logical_size, baseinteger): raise TypeError("logical_size can only be an instance of type baseinteger") if not isinstance(variant, list): raise TypeError("variant can only be an instance of type list") for a in variant[:10]: if not i...
def create_base_storage(self, logical_size, variant)
Starts creating a hard disk storage unit (fixed/dynamic, according to the variant flags) in the background. The previous storage unit created for this object, if any, must first be deleted using :py:func:`delete_storage` , otherwise the operation will fail. Before the operation ...
4.916532
4.368663
1.125409
if not isinstance(target, IMedium): raise TypeError("target can only be an instance of type IMedium") if not isinstance(variant, list): raise TypeError("variant can only be an instance of type list") for a in variant[:10]: if not isinstance(a, MediumV...
def create_diff_storage(self, target, variant)
Starts creating an empty differencing storage unit based on this medium in the format and at the location defined by the @a target argument. The target medium must be in :py:attr:`MediumState.not_created` state (i.e. must not have an existing storage unit). Upon successful ...
5.174194
3.906433
1.324532
if not isinstance(target, IMedium): raise TypeError("target can only be an instance of type IMedium") progress = self._call("mergeTo", in_p=[target]) progress = IProgress(progress) return progress
def merge_to(self, target)
Starts merging the contents of this medium and all intermediate differencing media in the chain to the given target medium. The target medium must be either a descendant of this medium or its ancestor (otherwise this method will immediately return a failure). It follows that the...
10.996946
7.779885
1.41351
if not isinstance(location, basestring): raise TypeError("location can only be an instance of type basestring") progress = self._call("moveTo", in_p=[location]) progress = IProgress(progress) return progress
def move_to(self, location)
Changes the location of this medium. Some medium types may support changing the storage unit location by simply changing the value of the associated property. In this case the operation is performed immediately, and @a progress is returning a @c null reference. Otherwise on success there...
9.984277
8.6
1.160962
if not isinstance(logical_size, baseinteger): raise TypeError("logical_size can only be an instance of type baseinteger") progress = self._call("resize", in_p=[logical_size]) progress = IProgress(progress) return progress
def resize(self, logical_size)
Starts resizing this medium. This means that the nominal size of the medium is set to the new value. Both increasing and decreasing the size is possible, and there are no safety checks, since VirtualBox does not make any assumptions about the medium contents. Resizing usually ne...
7.855119
6.730059
1.167169
if not isinstance(current_password, basestring): raise TypeError("current_password can only be an instance of type basestring") if not isinstance(cipher, basestring): raise TypeError("cipher can only be an instance of type basestring") if not isinstance(new_passw...
def change_encryption(self, current_password, cipher, new_password, new_password_id)
Starts encryption of this medium. This means that the stored data in the medium is encrypted. This medium will be placed to :py:attr:`MediumState.locked_write` state. Please note that the results can be either returned straight away, or later as the result of t...
2.114025
1.886824
1.120414
if not isinstance(password, basestring): raise TypeError("password can only be an instance of type basestring") self._call("checkEncryptionPassword", in_p=[password])
def check_encryption_password(self, password)
Checks whether the supplied password is correct for the medium. in password of type str The password to check. raises :class:`VBoxErrorNotSupported` Encryption is not configured for this medium. raises :class:`VBoxErrorPasswordIncorrect` The given p...
7.961405
8.016013
0.993188
if not isinstance(writable, bool): raise TypeError("writable can only be an instance of type bool") if not isinstance(password, basestring): raise TypeError("password can only be an instance of type basestring") medium_io = self._call("openForIO", ...
def open_for_io(self, writable, password)
Open the medium for I/O. in writable of type bool Set this to open the medium for both reading and writing. When not set the medium is opened readonly. in password of type str Password for accessing an encrypted medium. Must be empty if not encrypted. retu...
4.10341
3.624584
1.132105
(extensions, types) = self._call("describeFileExtensions") types = [DeviceType(a) for a in types] return (extensions, types)
def describe_file_extensions(self)
Returns two arrays describing the supported file extensions. The first array contains the supported extensions and the seconds one the type each extension supports. Both have the same size. Note that some backends do not work on files, so this array may be empty. ...
8.092849
5.136419
1.575582
(names, descriptions, types, flags, defaults) = self._call("describeProperties") types = [DataType(a) for a in types] return (names, descriptions, types, flags, defaults)
def describe_properties(self)
Returns several arrays describing the properties supported by this format. An element with the given index in each array describes one property. Thus, the number of elements in each returned array is the same and corresponds to the number of supported properties. ...
7.162772
4.853181
1.475892
if not isinstance(offset, baseinteger): raise TypeError("offset can only be an instance of type baseinteger") if not isinstance(data, list): raise TypeError("data can only be an instance of type list") for a in data[:10]: if not isinstance(a, basestri...
def write(self, offset, data)
Write data to the medium. in offset of type int The byte offset into the medium to start reading at. in data of type str Array of data to write. return written of type int How many bytes were actually written.
4.59608
4.238675
1.08432
if not isinstance(quick, bool): raise TypeError("quick can only be an instance of type bool") self._call("formatFAT", in_p=[quick])
def format_fat(self, quick)
Formats the medium as FAT. Generally only useful for floppy images as no partition table will be created. in quick of type bool Quick format it when set.
10.436941
12.579836
0.829656
if not isinstance(format_p, PartitionTableType): raise TypeError("format_p can only be an instance of type PartitionTableType") if not isinstance(whole_disk_in_one_entry, bool): raise TypeError("whole_disk_in_one_entry can only be an instance of type bool") self....
def initialize_partition_table(self, format_p, whole_disk_in_one_entry)
Writes an empty partition table to the disk. in format_p of type :class:`PartitionTableType` The partition table format. in whole_disk_in_one_entry of type bool When @c true a partition table entry for the whole disk is created. Otherwise the partition table is empt...
2.573757
2.32081
1.108991
if not isinstance(format_p, basestring): raise TypeError("format_p can only be an instance of type basestring") if not isinstance(variant, list): raise TypeError("variant can only be an instance of type list") for a in variant[:10]: if not isinstance(...
def convert_to_stream(self, format_p, variant, buffer_size)
Converts the currently opened image into a stream of the specified image type/variant. It is sufficient to open the image in read-only mode. Only few types and variants are supported due to the inherent restrictions of the output style. in format_p of type str Identifier of ...
3.549333
2.834147
1.252346
if not isinstance(scancode, baseinteger): raise TypeError("scancode can only be an instance of type baseinteger") self._call("putScancode", in_p=[scancode])
def put_scancode(self, scancode)
Sends a scancode to the keyboard. in scancode of type int raises :class:`VBoxErrorIprtError` Could not send scan code to virtual keyboard.
9.39668
8.721889
1.077368
if not isinstance(scancodes, list): raise TypeError("scancodes can only be an instance of type list") for a in scancodes[:10]: if not isinstance(a, baseinteger): raise TypeError( "array can only contain objects of type baseinteger"...
def put_scancodes(self, scancodes)
Sends an array of scancodes to the keyboard. in scancodes of type int return codes_stored of type int raises :class:`VBoxErrorIprtError` Could not send all scan codes to virtual keyboard.
7.135043
5.251307
1.358717
if not isinstance(dx, baseinteger): raise TypeError("dx can only be an instance of type baseinteger") if not isinstance(dy, baseinteger): raise TypeError("dy can only be an instance of type baseinteger") if not isinstance(dz, baseinteger): raise TypeE...
def put_mouse_event(self, dx, dy, dz, dw, button_state)
Initiates a mouse event using relative pointer movements along x and y axis. in dx of type int Amount of pixels the mouse should move to the right. Negative values move the mouse to the left. in dy of type int Amount of pixels the mouse should move downwards...
1.975563
1.917243
1.030419
if not isinstance(x, baseinteger): raise TypeError("x 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(dz, baseinteger): raise TypeError...
def put_mouse_event_absolute(self, x, y, dz, dw, button_state)
Positions the mouse pointer using absolute x and y coordinates. These coordinates are expressed in pixels and start from [1,1] which corresponds to the top left corner of the virtual display. The values [-1,-1] and [0x7fffffff,0x7fffffff] have special meanings as respectively "n...
1.959935
1.901517
1.030722
if not isinstance(count, baseinteger): raise TypeError("count can only be an instance of type baseinteger") if not isinstance(contacts, list): raise TypeError("contacts can only be an instance of type list") for a in contacts[:10]: if not isinstance(a...
def put_event_multi_touch(self, count, contacts, scan_time)
Sends a multi-touch pointer event. The coordinates are expressed in pixels and start from [1,1] which corresponds to the top left corner of the virtual display. The guest may not understand or may choose to ignore this event. :py:func...
3.221093
3.184125
1.01161
if not isinstance(count, baseinteger): raise TypeError("count can only be an instance of type baseinteger") if not isinstance(contacts, basestring): raise TypeError("contacts can only be an instance of type basestring") if not isinstance(scan_time, baseinteger): ...
def put_event_multi_touch_string(self, count, contacts, scan_time)
:py:func:`put_event_multi_touch` in count of type int :py:func:`put_event_multi_touch` in contacts of type str Contains information about all contacts: "id1,x1,y1,inContact1,inRange1;...;idN,xN,yN,inContactN,inRangeN". For example for two contacts: "0,...
2.855885
3.111734
0.917779
(address, width, height, bits_per_pixel, bytes_per_line, bitmap_format) = self._call("queryBitmapInfo") bitmap_format = BitmapFormat(bitmap_format) return (address, width, height, bits_per_pixel, bytes_per_line, bitmap_format)
def query_bitmap_info(self)
Information about the screen bitmap. out address of type str out width of type int out height of type int out bits_per_pixel of type int out bytes_per_line of type int out bitmap_format of type :class:`BitmapFormat`
3.060928
2.622978
1.166967
if not isinstance(x, baseinteger): raise TypeError("x 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(width, baseinteger): raise TypeEr...
def notify_update(self, x, y, width, height)
Informs about an update. Gets called by the display object where this buffer is registered. in x of type int in y of type int in width of type int in height of type int
2.334906
2.28647
1.021184
if not isinstance(x, baseinteger): raise TypeError("x 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(width, baseinteger): raise TypeEr...
def notify_update_image(self, x, y, width, height, image)
Informs about an update and provides 32bpp bitmap. in x of type int in y of type int in width of type int in height of type int in image of type str Array with 32BPP image data.
2.381512
2.376385
1.002157
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(x_origin, baseinteger): raise TypeError("x_origin can only be an instance of type baseinteger") if not isinstance(y_origin, basei...
def notify_change(self, screen_id, x_origin, y_origin, width, height)
Requests a size change. in screen_id of type int Logical guest screen number. in x_origin of type int Location of the screen in the guest. in y_origin of type int Location of the screen in the guest. in width of type int Width of the gu...
1.847841
1.872026
0.987081
if not isinstance(width, baseinteger): raise TypeError("width can only be an instance of type baseinteger") if not isinstance(height, baseinteger): raise TypeError("height can only be an instance of type baseinteger") if not isinstance(bpp, baseinteger): ...
def video_mode_supported(self, width, height, bpp)
Returns whether the frame buffer implementation is willing to support a given video mode. In case it is not able to render the video mode (or for some reason not willing), it should return @c false. Usually this method is called when the guest asks the VMM device whether a given video mo...
2.759493
2.77314
0.995079
if not isinstance(rectangles, basestring): raise TypeError("rectangles can only be an instance of type basestring") if not isinstance(count, baseinteger): raise TypeError("count can only be an instance of type baseinteger") count_copied = self._call("getVisibleRe...
def get_visible_region(self, rectangles, count)
Returns the visible region of this frame buffer. If the @a rectangles parameter is @c null then the value of the @a count parameter is ignored and the number of elements necessary to describe the current visible region is returned in @a countCopied. If @a rectangles is ...
5.636951
4.772285
1.181185
if not isinstance(rectangles, basestring): raise TypeError("rectangles can only be an instance of type basestring") if not isinstance(count, baseinteger): raise TypeError("count can only be an instance of type baseinteger") self._call("setVisibleRegion", ...
def set_visible_region(self, rectangles, count)
Suggests a new visible region to this frame buffer. This region represents the area of the VM display which is a union of regions of all top-level windows of the guest operating system running inside the VM (if the Guest Additions for this system support this functionality). This informa...
4.866943
5.46812
0.890058
if not isinstance(command, basestring): raise TypeError("command can only be an instance of type basestring") if not isinstance(enm_cmd, baseinteger): raise TypeError("enm_cmd can only be an instance of type baseinteger") if not isinstance(from_guest, bool): ...
def process_vhwa_command(self, command, enm_cmd, from_guest)
Posts a Video HW Acceleration Command to the frame buffer for processing. The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.) are posted from quest to the host to be processed by the host hardware. ...
2.768422
2.872389
0.963805
if not isinstance(type_p, baseinteger): raise TypeError("type_p can only be an instance of type baseinteger") if not isinstance(data, list): raise TypeError("data can only be an instance of type list") for a in data[:10]: if not isinstance(a, basestri...
def notify3_d_event(self, type_p, data)
Notifies framebuffer about 3D backend event. in type_p of type int event type. Currently only VBOX3D_NOTIFY_EVENT_TYPE_VISIBLE_3DDATA is supported. in data of type str event-specific data, depends on the supplied event type
4.028165
4.447155
0.905785
if not isinstance(x, baseinteger): raise TypeError("x can only be an instance of type baseinteger") if not isinstance(y, baseinteger): raise TypeError("y can only be an instance of type baseinteger") self._call("move", in_p=[x, y])
def move(self, x, y)
Changes the overlay's position relative to the IFramebuffer. in x of type int in y of type int
4.210358
4.585206
0.918248
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") (width, height, bits_per_pixel, x_origin, y_origin, guest_monitor_status) = self._call("getScreenResolution", in_p=[screen_id]) guest_moni...
def get_screen_resolution(self, screen_id)
Queries certain attributes such as display width, height, color depth and the X and Y origin for a given guest screen. The parameters @a xOrigin and @a yOrigin return the X and Y coordinates of the framebuffer's origin. All return parameters are optional. in sc...
4.168754
2.885181
1.444885
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(framebuffer, IFramebuffer): raise TypeError("framebuffer can only be an instance of type IFramebuffer") id_p = self._call("attach...
def attach_framebuffer(self, screen_id, framebuffer)
Sets the graphics update target for a screen. in screen_id of type int in framebuffer of type :class:`IFramebuffer` return id_p of type str
5.474771
4.221693
1.296819
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(id_p, basestring): raise TypeError("id_p can only be an instance of type basestring") self._call("detachFramebuffer", ...
def detach_framebuffer(self, screen_id, id_p)
Removes the graphics updates target for a screen. in screen_id of type int in id_p of type str
3.562052
3.90726
0.91165
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") framebuffer = self._call("queryFramebuffer", in_p=[screen_id]) framebuffer = IFramebuffer(framebuffer) return framebuffer
def query_framebuffer(self, screen_id)
Queries the graphics updates targets for a screen. in screen_id of type int return framebuffer of type :class:`IFramebuffer`
8.655266
7.668478
1.128681
if not isinstance(display, baseinteger): raise TypeError("display can only be an instance of type baseinteger") if not isinstance(enabled, bool): raise TypeError("enabled can only be an instance of type bool") if not isinstance(change_origin, bool): r...
def set_video_mode_hint(self, display, enabled, change_origin, origin_x, origin_y, width, height, bits_per_pixel)
Asks VirtualBox to request the given video mode from the guest. This is just a hint and it cannot be guaranteed that the requested resolution will be used. Guest Additions are required for the request to be seen by guests. The caller should issue the request and wait for a resolution cha...
1.482625
1.500015
0.988407
if not isinstance(enabled, bool): raise TypeError("enabled can only be an instance of type bool") self._call("setSeamlessMode", in_p=[enabled])
def set_seamless_mode(self, enabled)
Enables or disables seamless guest display rendering (seamless desktop integration) mode. Calling this method has no effect if :py:func:`IGuest.get_facility_status` with facility @c Seamless does not return @c Active. in enabled of type bool
7.315975
7.740767
0.945123
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(address, basestring): raise TypeError("address can only be an instance of type basestring") if not isinstance(width, baseinteger)...
def take_screen_shot(self, screen_id, address, width, height, bitmap_format)
Takes a screen shot of the requested size and format and copies it to the buffer allocated by the caller and pointed to by @a address. The buffer size must be enough for a 32 bits per pixel bitmap, i.e. width * height * 4 bytes. This API can be used only locally by a VM process ...
1.995497
2.016403
0.989632
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(width, baseinteger): raise TypeError("width can only be an instance of type baseinteger") if not isinstance(height, baseinteger):...
def take_screen_shot_to_array(self, screen_id, width, height, bitmap_format)
Takes a guest screen shot of the requested size and format and returns it as an array of bytes. in screen_id of type int The guest monitor to take screenshot from. in width of type int Desired image width. in height of type int Desired image height....
2.353533
2.191745
1.073817
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(address, basestring): raise TypeError("address can only be an instance of type basestring") if not isinstance(x, baseinteger): ...
def draw_to_screen(self, screen_id, address, x, y, width, height)
Draws a 32-bpp image of the specified size from the given buffer to the given point on the VM display. in screen_id of type int Monitor to take the screenshot from. in address of type str Address to store the screenshot to in x of type int Relative ...
1.824638
1.736364
1.050838
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") self._call("invalidateAndUpdateScreen", in_p=[screen_id])
def invalidate_and_update_screen(self, screen_id)
Redraw the specified VM screen. in screen_id of type int The guest screen to redraw.
9.032572
9.53759
0.94705
if not isinstance(command, basestring): raise TypeError("command can only be an instance of type basestring") self._call("completeVHWACommand", in_p=[command])
def complete_vhwa_command(self, command)
Signals that the Video HW Acceleration command has completed. in command of type str Pointer to VBOXVHWACMD containing the completed command.
8.176974
7.632071
1.071397
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(x, baseinteger): raise TypeError("x can only be an instance of type baseinteger") if not isinstance(y, baseinteger): ...
def viewport_changed(self, screen_id, x, y, width, height)
Signals that framebuffer window viewport has changed. in screen_id of type int Monitor to take the screenshot from. in x of type int Framebuffer x offset. in y of type int Framebuffer y offset. in width of type int Viewport width. ...
1.957319
1.894514
1.033151
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") display_source_bitmap = self._call("querySourceBitmap", in_p=[screen_id]) display_source_bitmap = IDisplaySourceBitmap(display_source_bitm...
def query_source_bitmap(self, screen_id)
Obtains the guest screen bitmap parameters. in screen_id of type int out display_source_bitmap of type :class:`IDisplaySourceBitmap`
5.534371
5.125575
1.079756
if not isinstance(screen_id, baseinteger): raise TypeError("screen_id can only be an instance of type baseinteger") if not isinstance(u32_scale_factor_w_multiplied, baseinteger): raise TypeError("u32_scale_factor_w_multiplied can only be an instance of type baseinteger")...
def notify_scale_factor_change(self, screen_id, u32_scale_factor_w_multiplied, u32_scale_factor_h_multiplied)
Notify OpenGL HGCM host service about graphics content scaling factor change. in screen_id of type int in u32_scale_factor_w_multiplied of type int in u32_scale_factor_h_multiplied of type int
2.026773
2.170629
0.933727
if not isinstance(f_unscaled_hi_dpi, bool): raise TypeError("f_unscaled_hi_dpi can only be an instance of type bool") self._call("notifyHiDPIOutputPolicyChange", in_p=[f_unscaled_hi_dpi])
def notify_hi_dpi_output_policy_change(self, f_unscaled_hi_dpi)
Notify OpenGL HGCM host service about HiDPI monitor scaling policy change. in f_unscaled_hi_dpi of type bool
4.128968
4.462942
0.925167
if not isinstance(screen_layout_mode, ScreenLayoutMode): raise TypeError("screen_layout_mode can only be an instance of type ScreenLayoutMode") if not isinstance(guest_screen_info, list): raise TypeError("guest_screen_info can only be an instance of type list") f...
def set_screen_layout(self, screen_layout_mode, guest_screen_info)
Set video modes for the guest screens. in screen_layout_mode of type :class:`ScreenLayoutMode` in guest_screen_info of type :class:`IGuestScreenInfo`
3.117102
2.917546
1.068399
if not isinstance(screen_ids, list): raise TypeError("screen_ids can only be an instance of type list") for a in screen_ids[:10]: if not isinstance(a, baseinteger): raise TypeError( "array can only contain objects of type baseinteg...
def detach_screens(self, screen_ids)
Unplugs monitors from the virtual graphics card. in screen_ids of type int
6.089757
6.271504
0.97102
if not isinstance(display, baseinteger): raise TypeError("display can only be an instance of type baseinteger") if not isinstance(status, GuestMonitorStatus): raise TypeError("status can only be an instance of type GuestMonitorStatus") if not isinstance(primary, ...
def create_guest_screen_info(self, display, status, primary, change_origin, origin_x, origin_y, width, height, bits_per_pixel)
Make a IGuestScreenInfo object with the provided parameters. in display of type int The number of the guest display. in status of type :class:`GuestMonitorStatus` @c True, if this guest screen is enabled, @c False otherwise. in primary of type bool ...
1.619253
1.486622
1.089216
if not isinstance(key, basestring): raise TypeError("key can only be an instance of type basestring") value = self._call("getProperty", in_p=[key]) return value
def get_property(self, key)
Returns the value of the network attachment property with the given name. If the requested data @a key does not exist, this function will succeed and return an empty string in the @a value argument. in key of type str Name of the property to get. return value of ty...
8.607763
9.631208
0.893737
if not isinstance(filename, basestring): raise TypeError("filename can only be an instance of type basestring") if not isinstance(compression, basestring): raise TypeError("compression can only be an instance of type basestring") self._call("dumpGuestCore", ...
def dump_guest_core(self, filename, compression)
Takes a core dump of the guest. See include/VBox/dbgfcorefmt.h for details on the file format. in filename of type str The name of the output file. The file must not exist. in compression of type str Reserved for future compression method indicator.
3.902542
4.329368
0.901411
if not isinstance(name, basestring): raise TypeError("name can only be an instance of type basestring") if not isinstance(args, basestring): raise TypeError("args can only be an instance of type basestring") info = self._call("info", in_p=[na...
def info(self, name, args)
Interfaces with the info dumpers (DBGFInfo). This feature is not implemented in the 4.0.0 release but it may show up in a dot release. in name of type str The name of the info item. in args of type str Arguments to the info dumper. return info ...
3.929665
3.861135
1.017749
if not isinstance(settings, basestring): raise TypeError("settings can only be an instance of type basestring") self._call("modifyLogGroups", in_p=[settings])
def modify_log_groups(self, settings)
Modifies the group settings of the debug or release logger. in settings of type str The group settings string. See iprt/log.h for details. To target the release logger, prefix the string with "release:".
9.654423
8.494488
1.136551
if not isinstance(settings, basestring): raise TypeError("settings can only be an instance of type basestring") self._call("modifyLogFlags", in_p=[settings])
def modify_log_flags(self, settings)
Modifies the debug or release logger flags. in settings of type str The flags settings string. See iprt/log.h for details. To target the release logger, prefix the string with "release:".
8.462607
9.17219
0.922638
if not isinstance(settings, basestring): raise TypeError("settings can only be an instance of type basestring") self._call("modifyLogDestinations", in_p=[settings])
def modify_log_destinations(self, settings)
Modifies the debug or release logger destinations. in settings of type str The destination settings string. See iprt/log.h for details. To target the release logger, prefix the string with "release:".
8.556443
8.08889
1.057802
if not isinstance(address, baseinteger): raise TypeError("address can only be an instance of type baseinteger") if not isinstance(size, baseinteger): raise TypeError("size can only be an instance of type baseinteger") bytes_p = self._call("readPhysicalMemory", ...
def read_physical_memory(self, address, size)
Reads guest physical memory, no side effects (MMIO++). This feature is not implemented in the 4.0.0 release but may show up in a dot release. in address of type int The guest physical address. in size of type int The number of bytes to read. re...
4.176279
3.916692
1.066277
if not isinstance(cpu_id, baseinteger): raise TypeError("cpu_id can only be an instance of type baseinteger") if not isinstance(address, baseinteger): raise TypeError("address can only be an instance of type baseinteger") if not isinstance(size, baseinteger): ...
def read_virtual_memory(self, cpu_id, address, size)
Reads guest virtual memory, no side effects (MMIO++). This feature is not implemented in the 4.0.0 release but may show up in a dot release. in cpu_id of type int The identifier of the Virtual CPU. in address of type int The guest virtual address. ...
2.807877
2.722114
1.031506
if not isinstance(cpu_id, baseinteger): raise TypeError("cpu_id can only be an instance of type baseinteger") if not isinstance(address, baseinteger): raise TypeError("address can only be an instance of type baseinteger") if not isinstance(size, baseinteger): ...
def write_virtual_memory(self, cpu_id, address, size, bytes_p)
Writes guest virtual memory, access handles (MMIO++) are ignored. This feature is not implemented in the 4.0.0 release but may show up in a dot release. in cpu_id of type int The identifier of the Virtual CPU. in address of type int The guest virtual ad...
2.475601
2.490056
0.994195
if not isinstance(name, basestring): raise TypeError("name can only be an instance of type basestring") plug_in_name = self._call("loadPlugIn", in_p=[name]) return plug_in_name
def load_plug_in(self, name)
Loads a DBGF plug-in. in name of type str The plug-in name or DLL. Special name 'all' loads all installed plug-ins. return plug_in_name of type str The name of the loaded plug-in.
6.427291
6.549245
0.981379
if not isinstance(name, basestring): raise TypeError("name can only be an instance of type basestring") self._call("unloadPlugIn", in_p=[name])
def unload_plug_in(self, name)
Unloads a DBGF plug-in. in name of type str The plug-in name or DLL. Special name 'all' unloads all plug-ins.
8.171885
9.481502
0.861877
if not isinstance(max_messages, baseinteger): raise TypeError("max_messages can only be an instance of type baseinteger") dmesg = self._call("queryOSKernelLog", in_p=[max_messages]) return dmesg
def query_os_kernel_log(self, max_messages)
Tries to get the kernel log (dmesg) of the guest OS. in max_messages of type int Max number of messages to return, counting from the end of the log. If 0, there is no limit. return dmesg of type str The kernel log.
7.609647
6.761678
1.125408
if not isinstance(cpu_id, baseinteger): raise TypeError("cpu_id can only be an instance of type baseinteger") if not isinstance(name, basestring): raise TypeError("name can only be an instance of type basestring") value = self._call("getRegister", ...
def get_register(self, cpu_id, name)
Gets one register. in cpu_id of type int The identifier of the Virtual CPU. in name of type str The register name, case is ignored. return value of type str The register value. This is usually a hex value (always 0x prefixed) but other format ma...
3.804834
3.874888
0.981921