Name
AddSharedFolder
Description
HRESULT
AddSharedFolder([in] BSTR shareName,
[in] BSTR hostPathName,
[in] LONG flags,
[in] ICallback* jobDoneCallback,
[out,retval] IJob** addJob);
This function mounts a new shared folder in the virtual machine.
Parameters
- shareName
-
Specifies the guest path name of the new shared folder.
- hostPathName
-
Specifies the host path of the shared folder.
- flags
-
The folder options.
- jobDoneCallback
-
An ICallback instance that will be called when the
operation is complete.
- addJob
-
Returns an IJob object that describes the state of this
asynchronous operation.
Return Value
HRESULT
Remarks
- This function creates a local mount point in the guest file system and
mounts a shared folder exported by the host.
- Shared folders will only be accessible inside the guest operating system if
shared folders are enabled for the virtual machine. See the documentation
for VM::EnableSharedFolders().
- The folder options include:
- VIX_SHAREDFOLDER_WRITE_ACCESS - Allow write access.
- Only absolute paths should be used for files in the guest; the resolution of
relative paths is not specified.
- The hostPathName argument must specify a path to a directory that exists on
the host, or an error will result.
- If a shared folder with the same name exists before calling this function,
the IJob object returned by this function will return VIX_E_ALREADY_EXISTS.
- It is not necessary to call VM::LoginInGuest() before calling this function.
- Shared folders are not supported for the following guest operating systems:
Windows ME, Windows 98, Windows 95, Windows 3.x, and DOS.
- In this release, this function requires the virtual machine to be powered on
with VMware Tools installed.
Side Effects
None.
Requirements
VixCOM.h, since VMware Workstation 6.0
Example
VBScript:
Dim job
Dim err
Set job = vm.AddSharedFolder("WorkDir", "/work", VixCOM.Constants.VIX_SHAREDFOLDER_WRITE_ACCESS, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
' Handle the error...
End If