org.virtualbox_4_3

Class ISharedFolder

java.lang.Object

org.virtualbox_4_3.ISharedFolder

public class ISharedFolder
extends java.lang.Object

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:

• Global(IVirtualBox.getSharedFolders()), shared folders available to all virtual machines.
• Permanent(IMachine.getSharedFolders()), VM-specific shared folders available to the given virtual machine at startup.
• Transient(IConsole.getSharedFolders()), VM-specific shared folders created in the session context (for example, when the virtual machine is running) and automatically discarded when the session is closed (the VM is powered off).

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 C_DRIVE(that points to C:\\), then creating a transient shared folder named C_DRIVE(that points to C:\\\\WINDOWS) will change the definition of C_DRIVEin the guest OS so that \\\\VBOXSVR\\C_DRIVEwill give access to C:\\WINDOWSinstead of C:\\on the host PC. Removing the transient shared folder C_DRIVEwill restore the previous (permanent) definition of C_DRIVEthat points to C:\\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: {8388DA11-B559-4574-A5B7-2BD7ACD5CEF8}

Constructor Summary

Constructors

Constructor and Description
ISharedFolder(org.virtualbox_4_3.jaxws.ISharedFolder real, org.virtualbox_4_3.jaxws.VboxPortType port)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getAccessible() Whether the folder defined by the host path is currently accessible or not.
java.lang.Boolean	getAutoMount() Whether the folder gets automatically mounted by the guest or not.
java.lang.String	getHostPath() Full path to the shared folder in the host file system.
java.lang.String	getLastAccessError() Text message that represents the result of the last accessibility check.
java.lang.String	getName() Logical name of the shared folder.
java.lang.Boolean	getWritable() Whether the folder defined by the host path is writable or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ISharedFolder

public ISharedFolder(org.virtualbox_4_3.jaxws.ISharedFolder real,
             org.virtualbox_4_3.jaxws.VboxPortType port)

Method Detail

getName

public java.lang.String getName()

Logical name of the shared folder.

Returns:

String

getHostPath

public java.lang.String getHostPath()

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

Returns:

String

getAccessible

public java.lang.Boolean getAccessible()

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.

Returns:

Boolean

getWritable

public java.lang.Boolean getWritable()

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

Returns:

Boolean

getAutoMount

public java.lang.Boolean getAutoMount()

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

Returns:

Boolean

getLastAccessError

public java.lang.String getLastAccessError()

Text message that represents the result of the last accessibility check. Accessibility checks are performed each time the getAccessible()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).

Returns:

String