Edit C:\Program Files (x86)\VMware\VMware VIX\doc\lang\perl\functions\VMReadVariable.html

<html>
<head>
<meta HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<meta HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<link rel="stylesheet" href="../../../foundrydoc.css" type="text/css" charset="ISO-8859-1">
<link rel="stylesheet" href="foundrydoc.css" type="text/css" charset="ISO-8859-1">
</head>
<body>
<h1>Name</h1>
<b>VMReadVariable</b>
<h1>Description</h1>
<pre>
($err, $value) = VMReadVariable($vmHandle,
                                $variableType,
                                $name,
                                $options);
</pre>
<p>
This function reads variables from the virtual machine state. This includes
the virtual machine configuration, environment variables in the guest,
and VMware "Guest Variables".
<h1>Parameters</h1>
<dl>
<dt><i>vmHandle</i></dt>
<dd>
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
</dd>
<dt><i>variableType</i></dt>
<dd>
The type of variable to read. The currently supported values are:
<ul>
<li> VIX_VM_GUEST_VARIABLE -          A "Guest Variable". This is a runtime-only value; it is never 
stored persistently. This is the same guest variable that is 
exposed through the VMControl APIs, and is a simple way to pass 
runtime values in and out of the guest. 
<li> VIX_VM_CONFIG_RUNTIME_ONLY -     The configuration state of the virtual machine. This is the .vmx file
that is stored on the host. You can read this and it will return the 
persistent data. If you write to this, it will only be a runtime 
change, so changes will be lost when the VM powers off.
<li> VIX_GUEST_ENVIRONMENT_VARIABLE - An environment variable in the guest of
the VM. On a Windows NT series guest,
writing these values is saved persistently
so they are immediately visible to
every process. On a Linux or Windows 9X
guest, writing these values is not
persistent so they are only visible to
the VMware tools process.
</ul>
</dd>
<dt><i>name</i></dt>
<dd>
The name of the variable.
</dd>
<dt><i>options</i></dt>
<dd>
must be 0.
</dd>
</dl>
<h1>Return Value</h1>
$err.  The error code returned by the operation. For returned values, see Topics &gt; Error Codes.
<p>
$value.  The value of the variable.
<h1>Remarks</h1>
<ul>
<li> You must call 
VMLoginInGuest()
before calling this function to read a VIX_GUEST_ENVIRONMENT_VARIABLE value.
You do not have to call 
VMLoginInGuest()
to use this function to read a VIX_VM_GUEST_VARIABLE or a
VIX_VM_CONFIG_RUNTIME_ONLY value.
</ul>
<h1>Side Effects</h1>
None.
<h1>Requirements</h1>
<pre>
use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
</pre>
since Workstation 6.0
<h1>Example</h1>
This example writes and reads a variable you may define, called "myTestVariable".
<pre>
my $err = VIX_OK;
my $hostHandle = VIX_INVALID_HANDLE;
my $vmHandle = VIX_INVALID_HANDLE;
my $readValue = NULL;

($err, $hostHandle) = HostConnect(VIX_API_VERSION,
                                  VIX_SERVICEPROVIDER_VMWARE_WORKSTATION,
                                  undef, # hostName
                                  0, # hostPort
                                  undef, # userName
                                  undef, # password
                                  0, # options
                                  VIX_INVALID_HANDLE); # propertyListHandle

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

($err, $vmHandle) = VMOpen($hostHandle,
                           "c:\\Virtual Machines\\vm1\\win2000.vmx");
die "VMOpen() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;
                       
$err = VMPowerOn($vmHandle,
                 0, # powerOnOptions
                 VIX_INVALID_HANDLE);  # propertyListHandle
die "VMPowerOn() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

$err = VMWaitForToolsInGuest($vmHandle,
                             300); # timeoutInSeconds
die "VMWaitForToolsInGuest() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

$err = VMWriteVariable($vmHandle,
                       VIX_VM_GUEST_VARIABLE,
                       "myTestVariable",
                       "newValue",
                       0); # options
die "VMWriteVariable() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;
                              
$(err, $readValue) = VixVM_ReadVariable($vmHandle,
                                        VIX_VM_GUEST_VARIABLE,
                                        "myTestVariable",
                                        0); # options
die "VMReadVariable() failed, $err ", GetErrorText($err), "\n" if $err != VIX_OK;

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de