| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.virtualbox_7_1.IUnknown
org.virtualbox_7_1.ISharedFolder
public class ISharedFolder
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:
IVirtualBox.getSharedFolders()), shared
folders available to all virtual machines.IMachine.getSharedFolders()),
VM-specific shared folders available to the given virtual machine at
startup.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).C_DRIVE(that points toC:\\), then creating a
transient shared folder namedC_DRIVE(that points
toC:\\\\WINDOWS) will change the definition
ofC_DRIVEin the guest OS so
that\\\\VBOXSVR\\C_DRIVEwill give access
toC:\\WINDOWSinstead ofC:\\on the host
PC. Removing the transient shared folderC_DRIVEwill restore
the previous (permanent) definition ofC_DRIVEthat points
toC:\\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: {0B108B8C-62E0-4E06-9DFA-2F1A2AD70774}
| Field Summary | 
|---|
| Fields inherited from class org.virtualbox_7_1.IUnknown | 
|---|
| obj, objMgr, port | 
| Constructor Summary | |
|---|---|
| ISharedFolder(java.lang.String wrapped,
              org.virtualbox_7_1.ObjectRefManager objMgr,
              org.virtualbox_7_1.jaxws.VboxPortType port) | |
| Method Summary | |
|---|---|
|  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 | getAutoMountPoint()Desired mount point in the guest for automatically mounting the folder when getAutoMount()is set. | 
|  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. | 
|  SymlinkPolicy | getSymlinkPolicy()The security policy for allowing guest VMs to create symbolic links within a Shared Folder. | 
|  java.lang.Boolean | getWritable()Whether the folder defined by the host path is writable or not. | 
| static ISharedFolder | queryInterface(IUnknown obj) | 
|  void | setAutoMount(java.lang.Boolean value)Whether the folder gets automatically mounted by the guest or not. | 
|  void | setAutoMountPoint(java.lang.String value)Desired mount point in the guest for automatically mounting the folder when getAutoMount()is set. | 
|  void | setSymlinkPolicy(SymlinkPolicy value)The security policy for allowing guest VMs to create symbolic links within a Shared Folder. | 
|  void | setWritable(java.lang.Boolean value)Whether the folder defined by the host path is writable or not. | 
| Methods inherited from class org.virtualbox_7_1.IUnknown | 
|---|
| getObjMgr, getRemoteWSPort, getWrapped, releaseRemote | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public ISharedFolder(java.lang.String wrapped,
                     org.virtualbox_7_1.ObjectRefManager objMgr,
                     org.virtualbox_7_1.jaxws.VboxPortType port)
| Method Detail | 
|---|
public java.lang.String getName()
public java.lang.String getHostPath()
public java.lang.Boolean getAccessible()
public java.lang.Boolean getWritable()
public void setWritable(java.lang.Boolean value)
value - Booleanpublic java.lang.Boolean getAutoMount()
public void setAutoMount(java.lang.Boolean value)
value - Booleanpublic java.lang.String getAutoMountPoint()
getAutoMount()is set.  For Windows and
OS/2 guests this should be a drive letter, while other guests it should
be a absolute directory.  It is possible to combine the two, e.g.
"T:/mnt/testrsrc" will be attached to "T:" by windows and OS/2 while
the unixy guests will mount it at "/mnt/testrsrc".
When empty the guest will choose a mount point.  The guest may do so
too should the specified mount point be in use or otherwise unusable.
public void setAutoMountPoint(java.lang.String value)
getAutoMount()is set.  For Windows and
OS/2 guests this should be a drive letter, while other guests it should
be a absolute directory.  It is possible to combine the two, e.g.
"T:/mnt/testrsrc" will be attached to "T:" by windows and OS/2 while
the unixy guests will mount it at "/mnt/testrsrc".
When empty the guest will choose a mount point.  The guest may do so
too should the specified mount point be in use or otherwise unusable.
value - Stringpublic java.lang.String getLastAccessError()
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).
public SymlinkPolicy getSymlinkPolicy()
public void setSymlinkPolicy(SymlinkPolicy value)
value - org.virtualbox_7_1.SymlinkPolicypublic static ISharedFolder queryInterface(IUnknown obj)
| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||