Name

Description

HRESULT
RunScriptInGuest([in] BSTR interrpeter,
                 [in] BSTR scriptText,
                 [in] LONG options,
                 [in] IVixHandle* propertyList,
                 [in] ICallback* jobDoneCallback,
                 [out,retval] IJob** runJob);

This function runs a script in the guest operating system.

Parameters

interpreter

The path to the script interpreter.

scriptText

The text of the script.

options

Run options for the program. See the notes below.

propertyListHandle

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

jobDoneCallback

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

runJob

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

Return Value

Remarks

• This function runs the script in the guest operating system.
• The current working directory for the script executed in the guest is not defined. Absolute paths should be used for files in the guest, including the path to the interpreter, and any files referenced in the script text.
• You must call VM::LoginInGuest() before calling this function.
• If the options parameter is 0, this function will report completion to the IJob object when the program exits in the guest operating system. Alternatively, you can pass VixCOM.Constants.VIX_RUNPROGRAM_RETURN_IMMEDIATELY as the value of the options parameter, and this function reports completion to the IJob object as soon as the program starts in the guest.
• When the job is signaled, the following properties will be available on the returned IJob object:
  • VIX_PROPERTY_JOB_RESULT_PROCESS_ID: the process id; however, if the gues has an older version of Tools (those released with Workstation 6 and earlier) and the VixCOM.Constants.VIX_RUNPROGRAM_RETURN_IMMEDIATELY flag is used, then the process ID will not be returned from the guest and this property will not be set on the job handle, so attempting to access this property will result in VIX_E_UNRECOGNIZED_PROPERTY being returned;
  • VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_ELAPSED_TIME: the process elapsed time;
  • VIX_PROPERTY_JOB_RESULT_GUEST_PROGRAM_EXIT_CODE: the process exit code.
  If the option parameter is VixCOM.Constants.VIX_RUNPROGRAM_RETURN_IMMEDIATELY, the latter two will both be 0.

Side Effects

Requirements

Example

Dim lib
Dim host
Dim job
Dim vm
Dim result

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)
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

Dim scriptText

scriptText = "if (!open IN, "<", "in.txt") { die "failed to open input file"};\n"
scriptText = scriptText & "if (!open OUT, ">", "out.txt") { die "failed to open output file"};\n"
scriptText = scriptText & "@input = <IN>;\n"
scriptText = scriptText & "@reverse = reverse @input;\n"
scriptText = scriptText & "print OUT @reverse;\n"

Set job = vm.RunScriptInGuest("c:\perl\perl.exe", scriptText, 0, Nothing, Nothing)
err = job.WaitWithoutResults()
If lib.ErrorIndicatesFailure(err) Then
   ' Handle the error...
End If

host.Disconnect()