DismMountImage 関数
WIM または VHD イメージ ファイルを指定された場所にマウントします。
構文
HRESULT WINAPI DismMountImage(
_In_ PCWSTR ImageFilePath,
_In_ PCWSTR MountPath,
_In_ UINT ImageIndex,
_In_opt_ PCWSTR ImageName,
_In_ DismImageIdentifier ImageIdentifier,
_In_ DWORD Flags,
_In_opt_ HANDLE CancelEvent,
_In_opt_ DISM_PROGRESS_CALLBACK Progress,
_In_opt_ PVOID UserData
);
パラメーター
ImageFilePath [in]
ローカル コンピューター上の WIM ファイルまたは VHD ファイルへのパス。 .wim、.vhd、.vhdx ファイル名拡張子が必要です。
MountPath [in]
イメージをマウントする場所のパス。 このマウントパスは、コンピューター上に既に存在している必要があります。 .wim、.vhd、.vhdx ファイルの Windows イメージは、NTFS でフォーマットされたドライブ上の空のフォルダーにマウントできます。 .vhd または .vhdx ファイル内の Windows イメージを、割り当てられていないドライブ文字にマウントすることもできます。 既存のドライブのルートにイメージをマウントすることはできません。
ImageIndex [in]
マウントする WIM ファイル内のイメージのインデックス。 VHD ファイルの場合は、1 のインデックスを指定する必要があります。
ImageName [in、オプション]
省略可能。 マウントするイメージの名前。
ImageIdentifier [in]
DismImageIdentifier 列挙値 (DismImageIndex など)
Flags [in]
この操作に使用するマウント フラグ。 マウント フラグの詳細については、「DISM API 定数」をご覧ください。
CancelEvent [in、オプション]
任意。 この関数に対して CancelEvent を設定すると、クライアントからシグナルが送信されたときに進行中の操作をキャンセルできます。 操作をキャンセルできない段階で CancelEvent を受信した場合、操作は続行され、成功コードが返されます。 CancelEvent を受信し、操作がキャンセルされた場合、イメージの状態は不明です。 続行する前にイメージの状態を確認するか、変更を破棄してからもう一度開始する必要があります。
Progress [in、オプション]
任意。 クライアント定義の DismProgressCallback 関数へのポインター。
UserData [in、オプション]
任意。 ユーザー定義のカスタム データ。
戻り値
成功すると S_OK を返します。
パスのいずれかが整形式でない場合、または MountPath または ImageFilePath が存在しないか無効である場合、E_INVALIDARG を返します。
他のエラーについては、HRESULT にマップされた Win32 エラー コードを返します。
解説
イメージをマウントした後、DismOpenSession を使用してサービス セッションを開始します。 詳細については、「DISM API の使用」を参照してください。
ネットワークに格納されている WIM ファイルまたは VHD ファイルからイメージをマウントすることはサポートされていません。 ローカル コンピューター上のファイルを指定する必要があります。
VHD ファイルからイメージをマウントするには、1 の ImageIndex を指定する必要があります。
MountPath は、コンピューターに既に存在するファイル パスである必要があります。 WIM ファイルと VHD ファイルのイメージは、NTFS でフォーマットされたドライブ上の空のフォルダーにマウントできます。 VHD ファイルから割り当てられていないドライブ文字にイメージをマウントすることもできます。 既存のドライブのルートにイメージをマウントすることはできません。
WIM ファイルにイメージをマウントする場合、イメージは ImageIndex で指定されたイメージ インデックス番号、または ImageName で指定されたイメージの名前のいずれかで識別できます。 ImageIdentifier は、ImageIndex または ImageName パラメータを使用してイメージを識別するかどうかを指定します。
例
HRESULT hr = S_OK;
hr = DismMountImage(L” C:\\test\\images\\myimage.wim”, L"C:\\test\\offline", 1, NULL, DismImageIndex, DISM_MOUNT_READWRITE, NULL, NULL, NULL);
必要条件
| 要件 | 説明 |
|---|---|
| .wim ファイルでサポートされているホスト プラットフォーム | DISM API は、Windows アセスメント & デプロイメント キット (Windows ADK) でサポートされているすべてのオペレーティング システムで使用できます。 詳細については、Windows ADK のテクニカル リファレンスに関するページを参照してください。 |
| .vhd ファイルおよび .vhdx ファイルでサポートされているホスト プラットフォーム | Windows 7、Windows Server 2008 R2、Windows PE 3.0、Windows 8、Windows Server 2012、Windows プレインストール環境 (Windows PE) 4.0、Windows 8.1、Windows Server 2012 R2、Windows 10、Windows Server 2016 |
| サポートされている最小のクライアント | Windows 7 [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows Server 2008 R2 [デスクトップ アプリのみ] |
| Header | DismAPI.h |
| ライブラリ | DismAPI.lib |
| [DLL] | DismAPI.dll |