Name
VMAddSharedFolder
Description
$err = VMAddSharedFolder($vmHandle,
$shareName,
$hostPathName,
$flags);
This function mounts a new shared folder in the virtual machine.
Parameters
- vmHandle
-
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
- shareName
-
Specifies the guest path name of the new shared folder.
- hostPathName
-
Specifies the host path of the shared folder.
- flags
-
The folder options.
Return Value
$err. The error code returned by the operation. For returned values, see Topics > Error Codes.
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 VMEnableSharedFolders().
- 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 function will return VIX_E_ALREADY_EXISTS.
- It is not necessary to call VMLoginInGuest() 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
use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Workstation 6.0
Example
my $err;
$err = VMAddSharedFolder($vmHandle,
"WorkDir",
"/work",
VIX_SHAREDFOLDER_WRITE_ACCESS);