IVMVirtualMachine::GetActivationValue method

Article
05/31/2018

The GetActivationValue method returns the value of the specified activation setting for this virtual machine.

Syntax

HRESULT GetActivationValue(
  [in]  BSTR    activationKey,
  [out] VARIANT *activationValue
);

Parameters

activationKey [in]: Key used to identify the activation value as stored in the "*.vmc" file.
activationValue [out]: 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 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
S_OK	The operation was successful.
E_INVALIDARG	The activationKey parameter is NULL or empty.
E_POINTER	The activationValue parameter is NULL.
VM_E_VM_UNKNOWN	The configuration is unknown.
VM_E_PREF_NOT_FOUND	The preference was not found, or this configuration has no valid activation.
DISP_E_EXCEPTION	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. 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.

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 read 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	VsComInterfaces.h

Share via