Name

Description

HRESULT
GetSharedFolderState([in] LONG index,
                     [in] ICallback* jobDoneCallback,
                     [out,retval] IJob** getJob);

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

Parameters

index

Identifies the shared folder.

jobDoneCallback

A callback function that will be invoked when the operation is complete.

getJob

Returns an IJob object that describes the state of this asynchronous operation.

Return Value

Remarks

• Shared folders are indexed from 0 to n-1, where n is the number of shared folders. Use the function VM::GetNumSharedFolders() to get the value of n.
• When the job is signaled, the following properties will be available on the returned job handle:
  • VIX_PROPERTY_JOB_RESULT_ITEM_NAME the name of the folder
  • VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_HOST the host path its mounted from
  • VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_FLAGS flags describing the folder options VIX_SHAREDFOLDER_WRITE_ACCESS
• 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

Requirements

Example

Dim numResults
Dim results
Dim job
Dim error

Set job = vm.GetNumSharedFolders(Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_COUNT), results)
If lib.ErrorIndicatesFailure(err) Then
   WScript.Echo("Error: " & lib.GetErrorText(err, empty))
   WScript.Quit
End If
numResults = results(0)

Dim propIds
Redim propIds(2)
' Build an array of properties to request
propIds(0) = VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_ITEM_NAME
propIds(1) = VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_HOST
propIds(2) = VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_FLAGS
For i=0 to numResults-1
   Set job = vm.GetSharedFolderState(i, Nothing)
   ' Wait for the result, and get the result properties  
   err = job.Wait(propIds, results)
   If lib.ErrorIndicatesFailure(err) Then
      WScript.Echo("Error: " & lib.GetErrorText(err, empty))
      WScript.Quit
   End If
   folderName = results(0)       ' VIX_PROPERTY_JOB_RESULT_ITEM_NAME
   folderHostPath = results(1)   ' VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_HOST
   folderFlags = results(2)      ' VIX_PROPERTY_JOB_RESULT_SHARED_FOLDER_FLAGS
   WScript.Echo(folderName & " on " & folderHostPath & " with flags: " & folderFlags)
Next