VirtualBox Main API
Public Attributes | List of all members
ISharedFolder Interface Reference

The ISharedFolder interface represents a folder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name. More...

Inheritance diagram for ISharedFolder:

Public Attributes

readonly attribute wstring name
 Logical name of the shared folder. More...
 
readonly attribute wstring hostPath
 Full path to the shared folder in the host file system. More...
 
readonly attribute boolean accessible
 Whether the folder defined by the host path is currently accessible or not. More...
 
readonly attribute boolean writable
 Whether the folder defined by the host path is writable or not. More...
 
readonly attribute boolean autoMount
 Whether the folder gets automatically mounted by the guest or not. More...
 
readonly attribute wstring lastAccessError
 Text message that represents the result of the last accessibility check. More...
 

Detailed Description

The ISharedFolder interface represents a folder in the host computer's file system accessible from the guest OS running inside a virtual machine using an associated logical name.

There are three types of shared folders:

  Logical names of shared folders must be unique within the given scope
  (global, permanent or transient). However, they do not need to be unique
  across scopes. In this case, the definition of the shared folder in a
  more specific scope takes precedence over definitions in all other
  scopes. The order of precedence is (more specific to more general):
  1. Transient definitions
  2. Permanent definitions
  3. Global definitions
  For example, if MyMachine has a shared folder named
  <tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
  transient shared folder named <tt>C_DRIVE</tt> (that points
  to <tt>C:\\\\WINDOWS</tt>) will change the definition
  of <tt>C_DRIVE</tt> in the guest OS so
  that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
  to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
  PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
  the previous (permanent) definition of <tt>C_DRIVE</tt> that points
  to <tt>C:\\</tt> if it still exists.

  Note that permanent and transient shared folders of different machines
  are in different name spaces, so they don't overlap and don't need to
  have unique logical names.
Note
Global shared folders are not implemented in the current version of the product.
Interface ID:
{15AABE95-E594-4E18-9222-B5E83A23F1DA}

Member Data Documentation

readonly attribute wstring ISharedFolder::name

Logical name of the shared folder.

readonly attribute wstring ISharedFolder::hostPath

Full path to the shared folder in the host file system.

readonly attribute boolean ISharedFolder::accessible

Whether the folder defined by the host path is currently accessible or not.

For example, the folder can be inaccessible if it is placed on the network share that is not available by the time this property is read.

readonly attribute boolean ISharedFolder::writable

Whether the folder defined by the host path is writable or not.

readonly attribute boolean ISharedFolder::autoMount

Whether the folder gets automatically mounted by the guest or not.

readonly attribute wstring ISharedFolder::lastAccessError

Text message that represents the result of the last accessibility check.

Accessibility checks are performed each time the accessible attribute is read. An empty string is returned if the last accessibility check was successful. A non-empty string indicates a failure and should normally describe a reason of the failure (for example, a file read error).