Name

VixVM_EnableSharedFolders

Description

VixHandle
VixVM_EnableSharedFolders(VixHandle vmHandle,
                          Bool enabled,      
                          int options,       
                          VixEventProc *callbackProc,
                          void *clientData);

This function enables or disables all shared folders as a feature for a virtual machine.

Parameters

vmHandle: Identifies a virtual machine. Call VixVM_Open() to create a virtual machine handle.
enabled: TRUE if enabling shared folders is desired. FALSE otherwise.
options: Must be 0.
callbackProc: A callback function that will be invoked when the operation is complete.
clientData: A parameter that will be passed to the callbackProc function.

Return Value

VixHandle. A job handle that describes the state of this asynchronous operation.

Remarks

This function enables/disables all shared folders as a feature on a virtual machine. In order to access shared folders on a guest, the feature has to be enabled, and in addition, the individual shared folder has to be enabled.
It is not necessary to call VixVM_LoginInGuest() before calling this function.
In this release, this function requires the virtual machine to be powered on with VMware Tools installed.
Shared folders are not supported for the following guest operating systems: Windows ME, Windows 98, Windows 95, Windows 3.x, and DOS.

Side Effects

On Linux virtual machines, calling this function will automatically mount shared folder(s) in the guest.

Requirements

vix.h, since VMware Workstation 6.0, not available on Server 2.0.
Minimum Supported Guest OS: Microsoft Windows NT Series, Linux

Example

VixHandle jobHandle;
VixError err;

jobHandle = VixVM_EnableSharedFolders(vmHandle, 
                                      TRUE,
                                      0,
                                      NULL, 
                                      NULL);
err = VixJob_Wait(jobHandle, VIX_PROPERTY_NONE);
Vix_ReleaseHandle(jobHandle);
if (VIX_OK != err) {
   // handle error
}