Name

Description

HRESULT
CopyFileFromHostToGuest([in] BSTR hostPathName,
                        [in] BSTR guestPathName,
                        [in] LONG options,
                        [in] IVixHandle* propertyList,
                        [in] ICallback* jobDoneCallback,
                        [out,retval] IJob** copyJob);

Copies a file or directory from the local system (where the Vix client is running) to the guest operating system.

Parameters

hostPathName

The path name of a file on a file system available to the Vix client.

guestPathName

The path name of a file on a file system available to the guest.

options

Must be 0.

propertyListHandle

Must be NULL (C++), null (C#), or Nothing (VB).

jobDoneCallback

An ICallback instance that will be called when the operation is complete.

copyJob

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

Return Value

Remarks

• The virtual machine must be running while the file is copied from the Vix client machine to the guest operating system.
• Existing files of the same name are overwritten, and folder contents are merged.
• The copy operation requires VMware Tools to be installed and running in the guest operating system.
• You must call VM::LoginInGuest() before calling this function.
• The format of the file name depends on the guest or local operating system. For example, a path name for a Microsoft Windows guest or host requires backslash as a directory separator, whereas a Linux guest or host requires a forward slash. In C#, if the path name includes backslash characters, you need to precede each one with an escape character (as in "C:\\temp\\file.dat"). Escape characters are not needed in VB or VBScript.
• Only absolute paths should be used for files in the guest; the resolution of relative paths is not specified.
• If any file fails to be copied, Vix aborts the operation, does not attempt to copy the remaining files, and returns an error.
• In order to copy a file to a mapped network drive in a Windows guest operating system, it is necessary to call LoginInGuest() with the VIX_LOGIN_IN_GUEST_REQUIRE_INTERACTIVE_ENVIRONMENT flag set. Using the interactive session option incurs an overhead in file transfer speed.

Side Effects

Requirements

Example

Dim lib
Dim host
Dim job
Dim vm
Dim results

Set lib = CreateObject("VixCOM.VixLib")


Set job = lib.Connect(VixCOM.Constants.VIX_API_VERSION, VixCOM.Constants.VIX_SERVICEPROVIDER_VMWARE_WORKSTATION, Empty, 0, Empty, Empty, 0, Nothing, Nothing)

' results needs to be initialized before it's used, even if it's just going to be overwritten.
Set results = Nothing

err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set host = results(0)

Set job = host.OpenVM("c:\Virtual Machines\vm1\win2000.vmx", Nothing)
err = job.Wait(Array(VixCOM.Constants.VIX_PROPERTY_JOB_RESULT_HANDLE), results)
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set vm = results(0)

Set job = vm.PowerOn(VixCOM.Constants.VIX_VMPOWEROP_LAUNCH_GUI, Nothing, Nothing)
' WaitWithoutResults is just like Wait, except it does not get any properties. 
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set job = vm.WaitForToolsInGuest(300, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set job = vm.LoginInGuest("vixuser", "secret", 0, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set job = vm.CopyFileFromHostToGuest("c:\hostDir\helloworld.c", "c:\guestDir\helloworld.c", 0, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

Set results = Nothing
Set job = Nothing
Set vm = Nothing

host.Disconnect()