Name

VMGetSharedFolderState

Description

($err, $folderFlags, $folderName, $folderHostPath) = VMSetSharedFolderState($vmHandle,
                                                                            $index);

This function returns the state of a shared folder mounted in the virtual machine.

Parameters

vmHandle: Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
index: Identifies the shared folder.

Return Value

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

$folderFlags. Flags describing the folder options VIX_SHAREDFOLDER_WRITE_ACCESS

$folderName. The name of the folder.

$folderHostPath. The host path the folder is mounted from.

Remarks

Shared folders are indexed from 0 to n-1, where n is the number of shared folders. Use the function VMGetNumSharedFolders() to get the value of n.
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;
my $numSharedFolders;
my $folderName;
my $folderHostPath;
my $folderFlags;
my $i;

($err, $numSharedFolders) = VMGetNumSharedFolders($vmHandle);
die "VMGetNumSharedFolders() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

for ($i = 0; $i < $numSharedFolders; $i++) {
   ($err, $folderFlags, $folderName, $folderHostPath) = VMGetSharedFolderState($vmHandle, $i);
   die "VMGetSharedFolderState() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

   print "Folder #$i: $folderHostPath:$folderName, $folderFlags\n";
   
}