DismOpenSession 関数

  • [アーティクル]

オフラインまたはオンラインの Windows イメージを DISMSession に関連付けます。

構文

HRESULT WINAPI DismOpenSession(
  _In_     PCWSTR      ImagePath,
  _In_opt_ PCWSTR      WindowsDirectory,
  _In_opt_ PCWSTR      SystemDrive,
  _Out_    DismSession *Session
);

パラメーター

ImagePath [in]
ImagePath を次のいずれかの値に設定します。

  • オフラインの Windows イメージのルート ディレクトリへの絶対パスまたは相対パス。
  • マウントされた Windows イメージのルート ディレクトリへの絶対パスまたは相対パス。 外部ツールを使用するか、DismMountImage を使用すると、DismOpenSession を呼び出す前にイメージをマウントできます。
  • DISM_ONLINE_IMAGE は、セッションをオンラインの Windows インストールに関連付けます。

WindowsDirectory [in、オプション]
省略可能。 Windows ディレクトリへの相対パスまたは絶対パス。 パスはマウント ポイントを基準にしています。

WindowsDirectory の値が NULL の場合、既定値の "Windows" が使用されます。

ImagePath パラメーターが DISM_ONLINE_IMAGE に設定されている場合、WindowsDirectory パラメーターは使用できません。

SystemDrive [in、オプション]
省略可能。 ブート マネージャーを含むシステム ドライブの文字。 SystemDrive が NULL の場合、マウント ポイントを含むドライブの既定値が使用されます。

ImagePath パラメーターが DISM_ONLINE_IMAGE に設定されている場合、SystemDrive パラメーターは使用できません。

Session [out]
有効な DismSession。 DismSession はイメージに関連付けられている必要があります。 セッションをイメージに関連付けるには、DismOpenSession を使用します。

戻り値

成功すると S_OK を返します。

DismSession にすでにイメージが関連付けられている場合は、HRESULT_FROM_WIN32(ERROR_ALREADY_EXISTS) を返します。

他のエラーについては、HRESULT にマップされた Win32 エラー コードを返します。

解説

DismOpenSession 呼び出しが正常に完了すれば、DismSession を使用してイメージを処理できます。 DismSession は、DismCloseSession を呼び出してシャットダウンする必要があります。

例

HRESULT hr = S_OK;
DismSession Session = DISM_SESSION_DEFAULT;
hr = DismOpenSession(L"C:\\Mount\\", NULL, NULL, &Session);

必要条件

要件 説明
サポートされているホスト プラットフォーム DISM API は、Windows アセスメント & デプロイメント キット (Windows ADK) でサポートされているすべてのオペレーティング システムで使用できます。 詳細については、「Windows ADK テクニカル リファレンス」を参照してください。
サポートされている最小のクライアント Windows 7 [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows Server 2008 R2 [デスクトップ アプリのみ]
Header DismAPI.h
ライブラリ DismAPI.lib
[DLL] DismAPI.dll

関連項目

DismSession

DismCloseSession

DismMountImage