Name

VMWriteVariable

Description

$err = VMWriteVariable($vmHandle,
                       $variableType,
                       $valueName,
                       $value,
                       $options)

This function writes variables to the virtual machine state. This includes the virtual machine configuration, environment variables in the guest, and VMware "Guest Variables".

Parameters

vmHandle
Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.
variableType
The type of variable to read. The currently supported values are:
valueName
The name of the variable.
value
The value to be written.
options
Must be 0.

Return Value

$err. The error code returned by the operation. For returned values, see Topics > Error Codes.

Remarks

Side Effects

May change configuration or environment variables.

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;
since VMware Workstation 6.0

Example

See the documentation for VMReadVariable().
Copyright (C) 2007-2010 VMware, Inc. All rights reserved.