IVMVirtualMachine::SetActivationValue method
The SetActivationValue method sets the value of the specified activation setting for this virtual machine.
Syntax
HRESULT SetActivationValue(
[in] BSTR activationKey,
[in] VARIANT activationValue
);
Parameters
-
activationKey [in]
-
Key used to identify the activation value as stored in the "*.vmc" file.
-
activationValue [in]
-
The activation value. Variant type may be one of: VT_ARRAY|VT_UI1 (raw bytes), VT_BSTR (string), VT_UI4 (integer), or VT_BOOL (Boolean).
Return value
This method can return one of these values.
This method supports standard return values, as well as the following. For information on Virtual Server specific return values not listed below, see HRESULT Codes Specific to the Virtual Server.
| Return code | Description |
|---|---|
|
The operation was successful. |
|
The activationKey parameter is NULL or empty, the activationValue parameter is NULL, or the activationValue parameter is not a valid variant type. |
|
The configuration is unknown. |
|
This configuration has no valid activation. |
|
An unexpected error has occurred. |
Remarks
This method provides low-level access to any activation value. It can be used to set activation values for customer-defined keys. Be careful if you use this method to set system activation values, since no error checking is performed on the activation value. Also, some activation values cannot be changed while the virtual machine is running. When a virtual machine is started, a copy is made of its configuration values, which becomes its set of activation values. Activation values are maintained until the virtual machine is shut down or restarted. Note that Virtual Server may only use the configuration to store values for certain keys, that is, the activation value may never be used.
Note
The virtual machine session must be running before any activation values can be changed.
Activation keys are stored internally in a hierarchical manner similar to the registry keys in Windows. To specify a specific subkey, a "key path" is constructed which specifies the various keys in a slash mark delimited format.
For example, to set the value of the "default_action" key located in the following key tree:
<settings>
<undo_drives>
<default_action type="integer">1</default_action>
The activationKey path string would be specified as follows:
"settings/undo_drives/default_action"
Requirements
| Product |
Microsoft Virtual Server 2005 onWindows Server 2003 |
| Download |
Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003 |
| Header |
|