Name

WriteVariable

Description

HRESULT
WriteVariable([in] LONG variableType,
              [in] BSTR valueName,
              [in] BSTR value,
              [in] LONG options,
              [in] ICallback* jobDoneCallback,
              [out,retval] IJob** writeJob);

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

variableType
The type of variable to write. The currently supported values are:
valueName
The name of the variable.
value
The value to be written.
options
Must be 0.
jobDoneCallback
A callback function that will be invoked when the operation is complete.
writeJob
Returns an IJob object that describes the state of this asynchronous operation.

Return Value

HRESULT

Remarks

Side Effects

May change configuration or environment variables.

Requirements

VixCOM.h, since VMware Workstation 6.0

Example

See the documentation for VM::ReadVariable().
Copyright (C) 2007-2011 VMware, Inc. All rights reserved.