IVMVirtualMachine::SetConfigurationValue メソッド

[Windows Virtual PC は、Windows 8の時点で使用できなくなります。 代わりに、 Hyper-V WMI プロバイダー (V2)を使用します。

この仮想マシン (VM) の指定した構成設定の値を設定します。

構文

HRESULT SetConfigurationValue(
  [in] BSTR    configurationKey,
  [in] VARIANT configurationValue
);

パラメーター

configurationKey [in]

"*.vmc" ファイルに格納されている構成値を識別するために使用されるキー。

重要

"*.vmc" に変更を加える必要があるのは 、SetConfigurationValue メソッドを使用する場合のみです。 他のメソッドを使用した "*.vmc" の変更はサポートされていません。

configurationValue [in]

構成値。 この値 cay は、VT_ARRAY VT_UI1(生バイト)、VT_BSTR| (文字列)、VT_UI4 (整数)、またはVT_BOOL (Boolean) のいずれかの VARIANT 型です。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード/値	説明
S_OK 0	操作に成功しました。
E_INVALIDARG 0x80000003	configurationKey パラメーターが NULL または空であるか、configurationValue パラメーターが有効なバリアント型ではありません。
VM_E_VM_UNKNOWN 0xA0040207	構成が不明です。
DISP_E_EXCEPTION 0x80020009	予期しないエラーが発生しました。

解説

configurationKey パラメーターでは、次の値がサポートされています。

configurationKey 値	説明	データの種類	既定値
"hardware/bios/time_sync_at_boot"	起動時に VM CMOS クロックをホスト クロックと同期させる場合は "true" です。それ以外の場合は "false" です。	"boolean"	"true"
"integration/microsoft/host_time_sync/enabled""	統合コンポーネントでホスト時刻同期が有効になっている場合は "true" です。それ以外の場合は "false" です。	"boolean"	"true"
"ui_options/auto_app_publish"	統合コンポーネントでアプリケーションの自動発行が有効になっている場合は "true" です。それ以外の場合は "false" です。 これは仮想アプリケーションとも呼ばれます。	"boolean"	"true"
"ui_options/seconds_to_save"	すべてのアプリケーションが閉じられた後、VM を保存するまで待機する秒数。 ただし、20 を下回り、4,294,968 を超える値には特別な意味があります。 詳細については、次の一覧を参照してください。 0 VM を保存しないでください。 1 20 VM を保存する前に 20 秒待ちます。 21 4,294,967 VM を保存する前に、指定した秒数待ちます。 4,294,968 4,294,967,295 VM を保存する前に 4,294,968 秒待ちます。	"integer"	300

このメソッドは、任意の構成値に対する低レベルのアクセスを提供します。 これを使用して、顧客定義キーの構成値を設定できます。 このメソッドを使用してシステム構成値を設定する場合は、構成値に対してエラー チェックが実行されないため、注意してください。 また、仮想マシンの実行中は、一部の構成値を変更できません。

構成キーは、仮想マシンの "*.vmc" ファイルに XML 形式で配置されます。 キーは、Windows のレジストリ キーと同様の階層的な方法で格納されます。 特定のサブキーを指定するために、さまざまなキーをスラッシュで区切られた形式で指定する "キー パス" が構築されます。

たとえば、次のキー ツリーにある "ram_size" キーの値を設定するには、

<preferences>
  <hardware>
    <bios>
      <time_sync_at_boot type="boolean">true</time_sync_at_boot>

configurationKey パス文字列は、次のように指定します。

"hardware/memory/ram_size"

目的のツリー内のいずれかのキーに "id" 属性値がある場合、属性とその値は、関連付けられている構成キーの直後に、かっこで囲まれた形式 "[@id="id_value"] を使用して configurationKey パス文字列に埋め込まれます。

たとえば、次のキー ツリーにある "golf" キーの値を設定するには、

<preferences>
  <alpha>
    <bravo>
      <charlie>
        <delta id="1">
          <echo id="0">
            <foxtrot>
              <golf type="string">D</golf>

configurationKey パス文字列は、次のように指定します。

"alpha/bravo/charlie/delta[@id=1]/echo[@id=0]/foxtrot/golf"

要件

要件	値
サポートされている最小のクライアント	Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー	サポートなし
クライアント サポートの終了	Windows 7
Product	Windows Virtual PC
ヘッダー	VPCCOMInterfaces.h
IID	IID_IVMVirtualMachineは f7092aa1-33ed-4f78-a59f-c00adfc2edd7 として定義されています

関連項目

IVMVirtualMachine

IVMVirtualPC::SetConfigurationValue