Метод IVMVirtualMachine::GetConfigurationValue

Статья
06/13/2023

[Виртуальный компьютер Windows больше недоступен для использования с Windows 8. Вместо этого используйте поставщик WMI Hyper-V (V2).]

Извлекает значение указанного параметра конфигурации для этой виртуальной машины.

Синтаксис

HRESULT GetConfigurationValue(
  [in]          BSTR    configurationKey,
  [out, retval] VARIANT *configurationValue
);

Параметры

configurationKey [in]: Ключ, используемый для идентификации значения конфигурации, хранящегося в файле "*.vmc".
configurationValue [out, retval]: Значение конфигурации. Это значение может быть одного из следующих типов VARIANT : VT_ARRAY|VT_UI1 (необработанные байты), VT_BSTR (строка), VT_I4 (целое число) или VT_BOOL (логическое значение).

Возвращаемое значение

Этот метод может возвращать одно из этих значений.

Возвращаемый код/значение	Описание
S_OK 0	Операция выполнена успешно.
E_INVALIDARG 0x80000003	Параметр configurationKey имеет значение NULL или пуст.
E_POINTER 0x80004003	Параметр configurationValue имеет значение NULL.
VM_E_VM_UNKNOWN 0xA0040207	Конфигурация неизвестна.
VM_E_PREF_NOT_FOUND 0xA0040300	Предпочтение не найдено.
DISP_E_EXCEPTION 0x80020009	Произошла непредвиденная ошибка.

Этот метод обеспечивает низкоуровневый доступ к любому значению конфигурации. Его можно использовать для чтения значений конфигурации для определяемых клиентом ключей.

Ключи конфигурации находятся в файле *.vmc виртуальной машины в формате XML. Ключи хранятся в иерархическом порядке, аналогично разделам реестра в Windows. Чтобы указать определенный подраздел, создается "путь к ключу", который задает различные ключи в формате с разделителями косой чертой.

Например, чтобы прочитать значение ключа ram_size, расположенного в следующем дереве ключей:

<hardware>
    <memory>
        <ram_size type="integer">128</ram_size>

Строка пути configurationKey будет указана следующим образом:

"hardware/memory/ram_size"

Если какой-либо из ключей в нужном дереве имеет значение атрибута id, атрибут и его значение внедряются в строку пути configurationKey сразу после связанного ключа конфигурации в следующем формате: "[@id="id_value"]".

Например, чтобы прочитать значение ключа absolute, расположенного в следующем дереве ключей:

<hardware>
    <pci_bus>
        <ide_adapter>
            <ide_controller id="1">
                <location id="0">
                    <pathname>
                        <absolute type="string">D</absolute>

Строка пути configurationKey будет указана следующим образом:

"hardware/pci_bus/ide_adapter/ide_controller[@id=1]/location[@id=0]/pathname/absolute"

Требования

Требование	Значение
Минимальная версия клиента	Windows 7 [только классические приложения]
Минимальная версия сервера	Ни одна версия не поддерживается
Окончание поддержки клиентов	Windows 7
Продукт	Windows Virtual PC
Заголовок	VPCCOMInterfaces.h
IID	IID_IVMVirtualMachine определяется как f7092aa1-33ed-4f78-a59f-c00adfc2edd7

См. также раздел

IVMVirtualMachine