Public Member Functions | |
| void | close () |
| TODO. | |
| void | copyFrom (in wstring source, in wstring dest, in CopyFileFlag[] flags,[retval] out IProgress progress) |
| TODO. | |
| void | copyTo (in wstring source, in wstring dest, in CopyFileFlag[] flags,[retval] out IProgress progress) |
| TODO. | |
| void | directoryCreate (in wstring path, in unsigned long mode, in DirectoryCreateFlag[] flags,[retval] out IGuestDirectory directory) |
| TODO. | |
| void | directoryCreateTemp (in wstring templateName, in unsigned long mode, in wstring path, in boolean secure,[retval] out wstring directory) |
| Create a temporary directory on the guest. | |
| void | directoryExists (in wstring path,[retval] out boolean exists) |
| TODO. | |
| void | directoryOpen (in wstring path, in wstring filter, in DirectoryOpenFlag[] flags,[retval] out IGuestDirectory directory) |
| TODO. | |
| void | directoryQueryInfo (in wstring path,[retval] out IGuestFsObjInfo info) |
| TODO. | |
| void | directoryRemove (in wstring path) |
| TODO. | |
| void | directoryRemoveRecursive (in wstring path, in DirectoryRemoveRecFlag[] flags,[retval] out IProgress progress) |
| TODO. | |
| void | directoryRename (in wstring source, in wstring dest, in PathRenameFlag[] flags) |
| TODO. | |
| void | directorySetACL (in wstring path, in wstring acl) |
| TODO. | |
| void | environmentClear () |
| TODO. | |
| void | environmentGet (in wstring name,[retval] out wstring value) |
| TODO. | |
| void | environmentSet (in wstring name, in wstring value) |
| TODO. | |
| void | environmentUnset (in wstring name) |
| TODO. | |
| void | fileCreateTemp (in wstring templateName, in unsigned long mode, in wstring path, in boolean secure,[retval] out IGuestFile file) |
| Create a temporary file on the guest. | |
| void | fileExists (in wstring path,[retval] out boolean exists) |
| TODO. | |
| void | fileRemove (in wstring path) |
| Remove a single file on the guest. | |
| void | fileOpen (in wstring path, in wstring openMode, in wstring disposition, in unsigned long creationMode, in long long offset,[retval] out IGuestFile file) |
| TODO. | |
| void | fileQueryInfo (in wstring path,[retval] out IGuestFsObjInfo info) |
| TODO. | |
| void | fileQuerySize (in wstring path,[retval] out long long size) |
| TODO. | |
| void | fileRename (in wstring source, in wstring dest, in PathRenameFlag[] flags) |
| TODO. | |
| void | fileSetACL (in wstring file, in wstring acl) |
| TODO. | |
| void | processCreate (in wstring command, in wstring[] arguments, in wstring[] environment, in ProcessCreateFlag[] flags, in unsigned long timeoutMS,[retval] out IGuestProcess guestProcess) |
| TODO. | |
| void | processCreateEx (in wstring command, in wstring[] arguments, in wstring[] environment, in ProcessCreateFlag[] flags, in unsigned long timeoutMS, in ProcessPriority priority, in long[] affinity,[retval] out IGuestProcess guestProcess) |
| TODO. | |
| void | processGet (in unsigned long pid,[retval] out IGuestProcess guestProcess) |
| TODO. | |
| void | symlinkCreate (in wstring source, in wstring target, in SymlinkType type) |
| TODO. | |
| void | symlinkExists (in wstring symlink,[retval] out boolean exists) |
| TODO. | |
| void | symlinkRead (in wstring symlink, in SymlinkReadFlag[] flags,[retval] out wstring target) |
| TODO. | |
| void | symlinkRemoveDirectory (in wstring path) |
| TODO. | |
| void | symlinkRemoveFile (in wstring file) |
| TODO. | |
Public Attributes | |
| readonly attribute wstring | user |
| TODO. | |
| readonly attribute wstring | domain |
| TODO. | |
| readonly attribute wstring | name |
| TODO. | |
| readonly attribute unsigned long | id |
| TODO. | |
| attribute unsigned long | timeout |
| TODO. | |
| attribute wstring[] | environment |
| TODO. | |
| readonly attribute IGuestProcess[] | processes |
| TODO. | |
| readonly attribute IGuestDirectory[] | directories |
| TODO. | |
| readonly attribute IGuestFile[] | files |
| TODO. | |
| void IGuestSession::close | ( | ) |
TODO.
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::copyFrom | ( | in wstring | source, | |
| in wstring | dest, | |||
| in CopyFileFlag[] | flags, | |||
| [retval] out IProgress | progress | |||
| ) |
TODO.
| source | TODO | |
| dest | TODO | |
| flags | TODO | |
| progress | Progress object to track the operation completion. |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::copyTo | ( | in wstring | source, | |
| in wstring | dest, | |||
| in CopyFileFlag[] | flags, | |||
| [retval] out IProgress | progress | |||
| ) |
TODO.
| source | TODO | |
| dest | TODO | |
| flags | TODO | |
| progress | Progress object to track the operation completion. |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::directoryCreate | ( | in wstring | path, | |
| in unsigned long | mode, | |||
| in DirectoryCreateFlag[] | flags, | |||
| [retval] out IGuestDirectory | directory | |||
| ) |
TODO.
| path | TODO | |
| mode | TODO | |
| flags | TODO | |
| directory | Optional. |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::directoryCreateTemp | ( | in wstring | templateName, | |
| in unsigned long | mode, | |||
| in wstring | path, | |||
| in boolean | secure, | |||
| [retval] out wstring | directory | |||
| ) |
Create a temporary directory on the guest.
| templateName | 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 alphanumeric string to produce a unique name. | |
| mode | The mode of the directory to create. Use 0700 unless there are reasons not to. This parameter is ignored if "secure" is specified. | |
| path | The absolute path to create the temporary directory in. | |
| secure | Whether to fail if the directory can not be securely created. Currently this means that another unprivileged user cannot manipulate the path specified or remove the temporary directory after it has been created. Also causes the mode specified to be ignored. May not be supported on all guest types. | |
| directory | On success this will contain the name of the directory created with full path. |
| VBOX_E_NOT_SUPPORTED | The operation is not possible as requested on this particular guest type. |
| E_INVALIDARG | Invalid argument. This includes an incorrectly formatted template, or a non-absolute path. |
| VBOX_E_IPRT_ERROR | The temporary directory could not be created. Possible reasons include a non-existing path or an insecure path when the secure option was requested. |
| void IGuestSession::directoryExists | ( | in wstring | path, | |
| [retval] out boolean | exists | |||
| ) |
| void IGuestSession::directoryOpen | ( | in wstring | path, | |
| in wstring | filter, | |||
| in DirectoryOpenFlag[] | flags, | |||
| [retval] out IGuestDirectory | directory | |||
| ) |
TODO.
| path | TODO | |
| filter | TODO | |
| flags | TODO | |
| directory | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::directoryQueryInfo | ( | in wstring | path, | |
| [retval] out IGuestFsObjInfo | info | |||
| ) |
| void IGuestSession::directoryRemove | ( | in wstring | path | ) |
| void IGuestSession::directoryRemoveRecursive | ( | in wstring | path, | |
| in DirectoryRemoveRecFlag[] | flags, | |||
| [retval] out IProgress | progress | |||
| ) |
TODO.
| path | TODO | |
| flags | TODO | |
| progress | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::directoryRename | ( | in wstring | source, | |
| in wstring | dest, | |||
| in PathRenameFlag[] | flags | |||
| ) |
| void IGuestSession::directorySetACL | ( | in wstring | path, | |
| in wstring | acl | |||
| ) |
| void IGuestSession::environmentClear | ( | ) |
TODO.
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::environmentGet | ( | in wstring | name, | |
| [retval] out wstring | value | |||
| ) |
| void IGuestSession::environmentSet | ( | in wstring | name, | |
| in wstring | value | |||
| ) |
| void IGuestSession::environmentUnset | ( | in wstring | name | ) |
| void IGuestSession::fileCreateTemp | ( | in wstring | templateName, | |
| in unsigned long | mode, | |||
| in wstring | path, | |||
| in boolean | secure, | |||
| [retval] out IGuestFile | file | |||
| ) |
Create a temporary file on the guest.
| templateName | 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 string to produce a unique name. | |
| mode | The mode of the file to create. Use 0700 unless there are reasons not to. This parameter is ignored if "secure" is specified. | |
| path | The absolute path to create the temporary file in. | |
| secure | Whether to fail if the file can not be securely created. Currently this means that another unprivileged user cannot manipulate the path specified or remove the temporary file after it has been created. Also causes the mode specified to be ignored. May not be supported on all guest types. | |
| file | On success this will contain an open file object for the new temporary file. |
| VBOX_E_NOT_SUPPORTED | The operation is not possible as requested on this particular guest type. |
| E_INVALIDARG | Invalid argument. This includes an incorrectly formatted template, or a non-absolute path. |
| VBOX_E_IPRT_ERROR | The temporary file could not be created. Possible reasons include a non-existing path or an insecure path when the secure option was requested. |
| void IGuestSession::fileExists | ( | in wstring | path, | |
| [retval] out boolean | exists | |||
| ) |
| void IGuestSession::fileRemove | ( | in wstring | path | ) |
Remove a single file on the guest.
| path | Path to the file to remove. |
| void IGuestSession::fileOpen | ( | in wstring | path, | |
| in wstring | openMode, | |||
| in wstring | disposition, | |||
| in unsigned long | creationMode, | |||
| in long long | offset, | |||
| [retval] out IGuestFile | file | |||
| ) |
TODO.
| path | TODO | |
| openMode | TODO | |
| disposition | TODO | |
| creationMode | TODO | |
| offset | TODO | |
| file | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::fileQueryInfo | ( | in wstring | path, | |
| [retval] out IGuestFsObjInfo | info | |||
| ) |
| void IGuestSession::fileQuerySize | ( | in wstring | path, | |
| [retval] out long long | size | |||
| ) |
| void IGuestSession::fileRename | ( | in wstring | source, | |
| in wstring | dest, | |||
| in PathRenameFlag[] | flags | |||
| ) |
| void IGuestSession::fileSetACL | ( | in wstring | file, | |
| in wstring | acl | |||
| ) |
| void IGuestSession::processCreate | ( | in wstring | command, | |
| in wstring[] | arguments, | |||
| in wstring[] | environment, | |||
| in ProcessCreateFlag[] | flags, | |||
| in unsigned long | timeoutMS, | |||
| [retval] out IGuestProcess | guestProcess | |||
| ) |
TODO.
| command | TODO | |
| arguments | TODO | |
| environment | TODO | |
| flags | TODO | |
| timeoutMS | TODO | |
| guestProcess | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::processCreateEx | ( | in wstring | command, | |
| in wstring[] | arguments, | |||
| in wstring[] | environment, | |||
| in ProcessCreateFlag[] | flags, | |||
| in unsigned long | timeoutMS, | |||
| in ProcessPriority | priority, | |||
| in long[] | affinity, | |||
| [retval] out IGuestProcess | guestProcess | |||
| ) |
TODO.
| command | TODO | |
| arguments | TODO | |
| environment | TODO | |
| flags | TODO | |
| timeoutMS | TODO | |
| priority | TODO | |
| affinity | TODO | |
| guestProcess | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::processGet | ( | in unsigned long | pid, | |
| [retval] out IGuestProcess | guestProcess | |||
| ) |
| void IGuestSession::symlinkCreate | ( | in wstring | source, | |
| in wstring | target, | |||
| in SymlinkType | type | |||
| ) |
TODO.
| source | TODO | |
| target | TODO | |
| type | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::symlinkExists | ( | in wstring | symlink, | |
| [retval] out boolean | exists | |||
| ) |
| void IGuestSession::symlinkRead | ( | in wstring | symlink, | |
| in SymlinkReadFlag[] | flags, | |||
| [retval] out wstring | target | |||
| ) |
TODO.
| symlink | TODO | |
| flags | TODO | |
| target | TODO |
| VBOX_E_NOT_SUPPORTED | TODO |
| void IGuestSession::symlinkRemoveDirectory | ( | in wstring | path | ) |
| void IGuestSession::symlinkRemoveFile | ( | in wstring | file | ) |
| readonly attribute wstring IGuestSession::user |
TODO.
| readonly attribute wstring IGuestSession::domain |
TODO.
| readonly attribute wstring IGuestSession::name |
TODO.
| readonly attribute unsigned long IGuestSession::id |
TODO.
| attribute unsigned long IGuestSession::timeout |
TODO.
| attribute wstring [] IGuestSession::environment |
TODO.
| readonly attribute IGuestProcess [] IGuestSession::processes |
TODO.
| readonly attribute IGuestDirectory [] IGuestSession::directories |
TODO.
| readonly attribute IGuestFile [] IGuestSession::files |
TODO.
1.7.1