IVMVirtualServer::GetConfigurationValue method

The GetConfigurationValue method returns preference data for the current user for the requested key.

Syntax

HRESULT GetConfigurationValue(
  [in]  BSTR    preferenceKey,
  [out] VARIANT *preferenceValue
);

Parameters

preferenceKey [in]

Key used to identify the preference, as stored in the configuration file.

preferenceValue [out]

Variant used to return the preference 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_POINTER	preferenceKey or preferenceValue is NULL.
VM_E_PREF_NOT_FOUND	The preference was not found.
DISP_E_EXCEPTION	An unexpected error occurred.

Remarks

This method provides low-level access to any preference value for the current user. It can be used to retrieve preference values for customer-defined keys.

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

See also

IVMVirtualServer