Index: /trunk/src/VBox/Main/idl/VirtualBox.xidl =================================================================== --- /trunk/src/VBox/Main/idl/VirtualBox.xidl (revision 42804) +++ /trunk/src/VBox/Main/idl/VirtualBox.xidl (revision 42805) @@ -5233,5 +5233,5 @@ - Allows to force unmount of a medium which is locked by + Allows to force unmount of a medium which is locked by the device slot in the given port medium is attached to. @@ -8957,5 +8957,5 @@ - + - TODO + File seeking types. - TODO - + Seek from the start of the file. + - TODO - + Seek from the current file position. + @@ -9004,5 +9004,5 @@ - + - TODO + Process waiting flags. Multiple flags can be combined. - TODO + No waiting flags specified. Do not use this. - TODO + Wait for the process being started. - TODO - + Wait for the process being terminated. + - TODO - + Wait for stdin becoming available. + - TODO - + Wait for data becoming available on stdout. + - TODO - + Wait for data becoming available on stderr. + - + - TODO + Process waiting results. Depending on the process waiting flags (for + more information see ) the waiting result + can vary based on the processes' current status. + + To wait for a gust process to terminate after it has been + created by or + one would specify ProcessWaitResult_Terminate. + + If a guest process has been started with + a client can wait with ProcessWaitResult_StdOut for new data to arrive on + stdout; same applies for and + ProcessWaitResult_StdErr. - TODO + No result was returned. Not being used. - TODO + The process has been started. - TODO + The process has been terminated. - TODO - + + The process has changed its status. The status then can + be retrieved via . + + - TODO - + Error while executing the process. + - TODO - + + The waiting operation timed out. This also will happen + when no event has been occured matching the specified the + current waiting flags in the call. + + - TODO - + + The process signalled that stdin became available for writing + and that the process awaits input now. + - TODO - + Data on stdout became available for reading. + - TODO + Data on stderr became available for reading. - TODO - + + A waiting flag specified in the call + is not supported by the guest. + + @@ -9078,6 +9101,5 @@ > - Host/Guest copy flags. At the moment none of these flags - are implemented. + File copying flags. @@ -9109,5 +9131,5 @@ - + - TODO + Directory recursive removement flags. No flag set. - + - TODO - + Delete the content of the directory and the directory itself. + - TODO - + Only delete the content of the directory, omit the directory it self. + - + - TODO + Path renaming flags. No flag set. - + - TODO - + Do not replace anything. + - TODO - + This will replace attempt any target which isn't a directory. + - TODO - + Don't allow symbolic links as part of the path. + - + - + - TODO + Process priorities. - TODO - + Invalid priority, do not use. + - TODO - + Default process priority determined by the OS. + - + - TODO + Symbolic link types. - TODO - + It is not known what is being targeted. + - TODO - + The link targets a directory. + - TODO - + The link targets a file (or whatever else). + - + - TODO + Symbolic link reading flags. - TODO. - + No flags set. + - TODO - + Don't allow symbolic links as part of the path. + - + - Guest process execution status. + Process execution statuses. @@ -9249,5 +9271,5 @@ - TODO + Process is being started. @@ -9255,8 +9277,8 @@ - TODO + Process has been paused. - TODO + Process is being terminated. @@ -9279,8 +9301,8 @@ - Something went wrong (error code in flags). + Something went wrong. - + - TODO + File system object type. - TODO - + Type is undefined / unknown. + - TODO - + Named pipe. + - TODO - + Character device. + - TODO - + Block device. + - TODO - + Directory. + - TODO - + File. + - TODO - + Symlink. + - TODO - + Socket. + - TODO - + Whiteout. + @@ -9399,106 +9421,88 @@ - + - + - - TODO - - TODO - - - - + Returns the user name used by this session to impersonate + users on the guest. + + + - - TODO - - TODO - - - - + Returns the domain name used by this session to impersonate + users on the guest. + + + - - TODO - - TODO - - - - + Returns the session's friendly name. + + - - TODO - - TODO - - - - + Returns the internal session ID. + + - TODO - - TODO - - - - + Returns the session timeout (in ms). + + The method is not implemented yet. + + + + - TODO - - - + Returns the current session environment. + + + - TODO - - - + Returns all current guest processes. + + + - TODO - - - + Returns all currently opened guest directories. + + + - TODO - - - + Returns all currently opened guest files. + + + - TODO - - - TODO - - - - + Closes this session. All opened guest directories, files and + processes which are not referenced by clients anymore will be + uninitialized. + + + - TODO - - - TODO + Copies a file from guest to the host. + + + Error starting the copy operation. - TODO + Source file on the guest to copy to the host. - TODO + Destination file name on the host. - TODO + Copy flags; see for more information. @@ -9506,21 +9510,21 @@ - + - TODO - - - TODO + Copies a file from host to the guest. + + + Error starting the copy operation. - TODO + Source file on the host to copy to the guest. - TODO + Destination file name on the guest. - TODO + Copy flags; see for more information. @@ -9528,27 +9532,24 @@ - + - TODO - - - TODO + Create a directory on the guest. + + + Error while creating the directory. - TODO + Full path of directory to create. - TODO + File creation mode. - TODO - - - Optional. - - - + Creation flags; see for more information. + + + @@ -9595,184 +9596,194 @@ - + - TODO - - - TODO + Checks whether a directory exists on the guest or not. + + + Error while checking existence of the directory specified. - TODO + Directory to check existence for. - TODO - - - + Returns @c true if the directory exists, @c false if not. + + + - TODO - - - TODO + Opens a directory and creates a object that + can be used for further operations. + + + Directory to open was not found. + + + Error while opening the directory. - TODO + Full path to file to open. - TODO + Open filter to apply. This can include wildcards like ? and *. - TODO + Open flags; see for more information. - TODO - - - + object containing the opened directory. + + + - TODO - - - TODO + Queries information of a directory on the guest. + + + Directory to query information for was not found. + + + Error querying information. - TODO + Directory to query information for. - TODO - - - + object containing the queried information. + + + - TODO - - - TODO + Removes a guest directory if not empty. + + + The method is not implemented yet. - TODO - - - + Full path of directory to remove. + + + - TODO - - - TODO + Removes a guest directory recursively. + + + The method is not implemented yet. - TODO + Full path of directory to remove recursively. - TODO + Remove flags; see for more information. - TODO - - - + Progress object to track the operation completion. + + + - TODO - - - TODO + Renames a directory on the guest. + + + The method is not implemented yet. - TODO + Source directory to rename. - TODO - - - TODO - - - + Destination directory to rename the source to. + + + Rename flags; see for more information. + + + - TODO - - - TODO + Sets the ACL (Access Control List) of a guest directory. + + + The method is not implemented yet. - TODO + Full path of directory to set the ACL for. - TODO - - - + Actual ACL string to set. Must comply with the guest OS. + + + - TODO - - - TODO - - - - + Clears (deletes) all session environment variables. + + + Error while clearing the session environment variables. + + + + - TODO - - - TODO + Gets the value of a session environment variable. + + + Error while getting the value of the session environment variable. - TODO + Name of session environment variable to get the value for. - TODO - - - + + Value of the session environment variable specified. If this variable + does not exist and empty value will be returned. + + + + - TODO - - - TODO + Sets a session environment variable. + + + Error while setting the session environment variable. - TODO + Name of session environment variable to set. - TODO - - - + Value to set the session environment variable to. + + + - TODO - - - TODO + Unsets session environment variable. + + + Error while unsetting the session environment variable. - TODO - - - + Name of session environment variable to unset (clear). + + + - Create a temporary file on the guest. + Creates a temporary file on the guest. @@ -9781,9 +9792,9 @@ - Invalid argument. This includes an incorrectly formatted template, + Invalid argument. This includes an incorrectly formatted template, or a non-absolute path. - The temporary file could not be created. Possible reasons include + The temporary file could not be created. Possible reasons include a non-existing path or an insecure path when the secure option was requested. @@ -9791,5 +9802,5 @@ - Template for the name of the file to create. This must contain + 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 @@ -9798,5 +9809,5 @@ - The mode of the file to create. Use 0700 unless there are + The mode of the file to create. Use 0700 unless there are reasons not to. This parameter is ignored if "secure" is specified. @@ -9818,25 +9829,31 @@ - + - TODO - - - TODO + Checks whether a file exists on the guest or not. + + + Error while checking existence of the file specified. - TODO + File to check existence for. - TODO - - - + Returns @c true if the file exists, @c false if not. + + + - Remove a single file on the guest. - + Removes a single file on the guest. + + + File to remove was not found. + + + Error while removing the file. + @@ -9844,450 +9861,527 @@ - + - TODO - - - TODO + Opens a file and creates a object that + can be used for further operations. + + + File to open was not found. + + + Error while opening the file. - TODO + Full path to file to open. - TODO + The file open mode. - TODO + The file disposition. - TODO + The file creation mode. - TODO + The initial read/write offset. - TODO - - - + object representing the opened file. + + + - TODO - - - TODO + Queries information of a file on the guest. + + + File to query information for was not found. + + + Error querying information. - TODO + File to query information for. - TODO - - - + object containing the queried information. + + + - TODO - - - TODO + Queries the size of a file on the guest. + + + File to rename was not found. + + + Error querying file size. - TODO + File to query the size for. - TODO - - - + Queried file size. + + + - TODO - - - TODO + Renames a file on the guest. + + + The method is not implemented yet. - TODO + Source file to rename. - TODO + Destination file to rename the source to. - TODO - - - + Rename flags; see for more information. + + + - TODO - - - TODO + Sets the ACL (Access Control List) of a file on the guest. + + + The method is not implemented yet. - TODO + Full path of file to set the ACL for. - TODO - - - + Actual ACL string to set. Must comply with the guest OS. + + + - TODO - - - TODO + Executes an existing program inside the guest VM. + + + Starting at VirtualBox 4.2 guest process execution by default is limited + to serve up to 255 guest processes at a time. If all 255 guest processes + are still active and running, starting a new guest process will result in an + appropriate error message. + + If + and / or respectively + is set, the guest process will not exit until all data from the specified + stream(s) is/are read out. + + To raise or lower the guest process execution limit, either the guest property + "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService' + command line by specifying "--control-procs-max-kept" needs to be modified. + A restart of the guest OS is required afterwards. To serve unlimited guest + processes, a value of "0" needs to be set (not recommended). + + + + Could not create process. - TODO + + Full path name of the command to execute on the guest; the + commands has to exists in the guest VM in order to be executed. + - TODO + Array of arguments passed to the execution command. - TODO + + Environment variables that can be set while the command is being + executed, in form of "NAME=VALUE"; one pair per entry. To unset a + variable just set its name ("NAME") without a value. + + This parameter can be used to override environment variables set by + the guest session, which will be applied to the newly started process + in any case. + - TODO + + Process creation flags; + see for more information. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - + Guest process object of the newly created process. + + + - TODO - - - TODO + Executes an existing program inside the guest VM. Extended version for + also setting the process priority and affinity. + + + Starting at VirtualBox 4.2 guest process execution by default is limited + to serve up to 255 guest processes at a time. If all 255 guest processes + are still active and running, starting a new guest process will result in an + appropriate error message. + + If + and / or respectively + is set, the guest process will not exit until all data from the specified + stream(s) is/are read out. + + To raise or lower the guest process execution limit, either the guest property + "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService' + command line by specifying "--control-procs-max-kept" needs to be modified. + A restart of the guest OS is required afterwards. To serve unlimited guest + processes, a value of "0" needs to be set (not recommended). + + + + Could not create process. - TODO + + Full path name of the command to execute on the guest; the + commands has to exists in the guest VM in order to be executed. + - TODO + Array of arguments passed to the execution command. - TODO + + Environment variables that can be set while the command is being + executed, in form of "NAME=VALUE"; one pair per entry. To unset a + variable just set its name ("NAME") without a value. + + This parameter can be used to override environment variables set by + the guest session, which will be applied to the newly started process + in any case. + - TODO + + Process creation flags; + see for more information. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO + + Process priority to use for execution; + see see for more information. - TODO + + Process affinity to use for execution. This parameter + is not implemented yet. + - TODO - - - + Guest process object of the newly created process. + + + - TODO - - - TODO - + Gets a certain guest process by its process ID (PID). - TODO + Process ID (PID) to get guest process for. - TODO - - - + Guest process of specified process ID (PID). + + + - TODO - - - TODO + Creates a symbolic link on the guest. + + + The method is not implemented yet. - TODO + The name of the symbolic link. - TODO + The path to the symbolic link target. - TODO - - - + + The symbolic link type; + see for more information. + + + + - TODO - - - TODO + Checks whether a symbolic link exists on the guest or not. + + + The method is not implemented yet. - TODO + Symbolic link to check existence for. - TODO - - - + Returns @c true if the symbolic link exists, @c false if not. + + + - TODO - - - TODO + Reads a symbolic link on the guest. + + + The method is not implemented yet. - TODO + Full path to symbolic link to read. - TODO + + Read flags; see for more information. + - TODO - - - + + Target of the symbolic link pointing to, if found. + + + + - TODO - - - TODO + Removes a symbolic link on the guest if it's a directory. + + + The method is not implemented yet. - TODO - - - + Symbolic link to remove. + + + - TODO - - - TODO + Removes a symbolic link on the guest if it's a file. + + + The method is not implemented yet. - TODO - - - - + Symbolic link to remove. + + + + - TODO + Abstract parent interface for processes handled by VirtualBox. - TODO - - TODO - + The process ID (PID). - TODO - - TODO - + The current process status; see + for more information. - TODO - - TODO - + The exit code. Only available when the process has been + terminated normally. - TODO - - TODO - + The environment block this process is using during execution. - TODO - - TODO - + The arguments this process is using for execution. - - TODO - - TODO - - + Full path of the actual executable image. - - TODO - - TODO - - - - + The friendly name of this process. + + - TODO - - - TODO - + Waits for one more events to happen. - TODO + + Specifies what to wait for; + see for more information. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - + + The overall wait result; + see for more information. + + + + + Waits for one more events to happen. Scriptable version of . - - - TODO - - TODO + + Specifies what to wait for; + see for more information. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - + + The overall wait result; + see for more information. + + + + - TODO - - - TODO - + Reads data from a running process. - TODO + Handle to read from. Usually 0 is stdin. - TODO + Number of bytes to read. - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - + Array of data read. + + + - TODO - - - TODO - + Writes data to a running process. - TODO + Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr. - flags. + A combination of flags. - TODO + + Array of bytes to write. The size of the array also specifies + how much to write. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - - - - TODO - - - TODO - + How much bytes were written. + + + + + + Writes data to a running process. + Scriptable version of . - TODO + Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr. - flags. + A combination of flags. - TODO + + Array of bytes to write. The size of the array also specifies + how much to write. + - TODO + + Timeout (in ms) to wait for the operation to complete. + Pass 0 for an infinite timeout. + - TODO - - - + How much bytes were written. + + + - TODO - - - TODO - + Terminates (kills) a running process. - + - TODO + Implementation of the object + for processes on the guest. - + - TODO + Abstract parent interface for directories handled by VirtualBox. - + Full path of directory. - - TODO - - - - + + + The open filter. - - TODO - - - - + + + - TODO - - - TODO - - - - + Closes this directory. After closing operations like reading the next + directory entry will not be possible anymore. + + + - TODO - + Reads the next directory entry of this directory. - End of directory listing reached. + No more directory entries to read. - TODO + Object information of the current directory entry read. Also see . - + - TODO + Implementation of the object + for directories on the guest. - + - TODO + Abstract parent interface for files handled by VirtualBox. - TODO - - TODO - + The creation mode. + + + The method is not implemented yet. + - TODO - - TODO - + The disposition mode. + + + The method is not implemented yet. + - TODO - - TODO - + Full path of the actual file name of this file. - TODO - - TODO - + The initial size in bytes when opened. + + + The method is not implemented yet. + - TODO - - TODO - + The open mode. + + + The method is not implemented yet. + - TODO - - TODO - - - - + Current read/write offset in bytes. + + + The method is not implemented yet. + + + + - TODO - - - TODO - - - - + Closes this file. After closing operations like reading data, + writing data or querying information will not be possible anymore. + + + The method is not implemented yet. + + + + - TODO - - - TODO + Queries information about this file. + + + The method is not implemented yet. - TODO - - - + Object information of this file. Also see . + + + - TODO - - - TODO + Reads data from this file. + + + The method is not implemented yet. - TODO + Number of bytes to read. - TODO + How much bytes were read. - TODO - - - + Array of data read. + + + - TODO - - - TODO + Reads data from an offset of this file. + + + The method is not implemented yet. - TODO + Offset in bytes to start reading. - TODO + Number of bytes to read. - TODO + How much bytes were read. - TODO - - - + Array of data read. + + + - TODO - - - TODO + Changes the read and write position of this file. + + + The method is not implemented yet. - TODO + Offset to seek. - TODO - - - + + Seek mode; see for more information. + + + + - TODO - - - TODO + Sets the ACL of this file. + + + The method is not implemented yet. - TODO - - - + ACL string to set. + + + - TODO - - - TODO - + Writes bytes to this file. - TODO + + Array of bytes to write. The size of the array also specifies + how much to write. + - TODO - - - + How much bytes were written. + + + - TODO - - - TODO + Writes bytes at a certain offset to this file. + + + The method is not implemented yet. - TODO + Offset in bytes to start writing. - TODO + + Array of bytes to write. The size of the array also specifies + how much to write. + - TODO + How much bytes were written. - + - TODO + Implementation of the object + for files on the guest. - + - TODO + Abstract parent interface for VirtualBox file system object information. + This can be information about a file or a directory, for example. - + - TODO - - TODO - + Time of last access (st_atime). - TODO - - TODO - + Disk allocation size (st_blocks * DEV_BSIZE). - TODO - - TODO - + Time of file birth (st_birthtime). - TODO - - TODO - + Time of last status change (st_ctime). - TODO - - TODO - + The device number of a character or block device type object (st_rdev). - TODO - - TODO - + File attributes. Not implemented yet. - TODO - - TODO - + The current generation number (st_gen). - TODO - - TODO - + The group the filesystem object is assigned (st_gid). - TODO - - TODO - + The group name. - TODO - - TODO - + Number of hard links to this filesystem object (st_nlink). - TODO - - TODO - + Time of last data modification (st_mtime). - TODO - - TODO - + The object's name. - TODO - - TODO - + The unique identifier (within the filesystem) of this filesystem object (st_ino). - TODO - - TODO - - - + The device number of the device which this filesystem object resides on (st_dev). + + - TODO - - TODO - + The logical size (st_size). For normal files this is the size of the file. + For symbolic links, this is the length of the path name contained in the + symbolic link. For other objects this fields needs to be specified. - TODO - - TODO - - - + The object type. See for more. + + - TODO - - TODO - + The user owning the filesystem object (st_uid). - TODO - - TODO - + User flags (st_flags). - TODO - - TODO - - - - + The user name. + + + - + - TODO + Represents the guest implementation of the + object. - + - TODO - - + Returns a collection of all opened guest sessions. + + Guest system memory balloon size in megabytes (transient property). @@ -11124,49 +11165,65 @@ - TODO + Creates a new guest session for controlling the guest. All operations + of a session object are using the same credentials specified with this + call. Anonymous sessions, that is, sessions without specifying a valid + user account on the guest are not allowed due to security reasons. Per + VM there can be 255 sessions at once. Using sessions across VMs is not + possible. + + A guest session holds all started or opened guest processes, guest + directories and guest files. + + Closing a session via will try to close + all the mentioned objects above unless these objects are still used by + a client. - TODO + User name this session will be using to control the guest; has to exist + and have the appropriate rights to execute programs in the VM. Must not + be empty. - TODO + Password of the user account to be used. Empty passwords are allowed. - TODO + Domain name of the user account to be used if the guest is part of + a domain. Optional. This feature is not implemented yet. - TODO + The session's friendly name. Optional, can be empty. - TODO - - - - + The newly created session object. + + + + - TODO - + Finds guest sessions by their friendly name and returns an interface + array with all found guest sessions. + - TODO + The session's friendly name to find. Wildcards like ? and * are allowed. - TODO - - - - + Array with all guest sessions found matching the name specified. + + + + @@ -13642,6 +13699,6 @@ The @a parent argument defines which medium will be the parent - of the clone. In this case the clone will be a base image, i.e. - completely independent. It is possible to specify an arbitrary + of the clone. In this case the clone will be a base image, i.e. + completely independent. It is possible to specify an arbitrary medium for this parameter, including the parent of the medium which is being cloned. Even cloning to a child of the source @@ -16962,5 +17019,5 @@ - +