DismAddPackage 関数
1 つの .cab または .msu ファイルを Windows イメージに追加します。
構文
HRESULT WINAPI DismAddPackage(
_In_ DismSession Session,
_In_ PCWSTR PackagePath,
_In_ BOOL IgnoreCheck,
_In_ BOOL PreventPending,
_In_opt_ HANDLE CancelEvent,
_In_opt_ DISM_PROGRESS_CALLBACK Progress,
_In_opt_ PVOID UserData
);
パラメーター
Session [in]
有効な DismSession。 DismSession はイメージに関連付けられている必要があります。 セッションをイメージに関連付けるには、DismOpenSession を使用します。
PackagePath [in]
追加する .cab または .msu ファイル、または単一の .cab ファイルの展開されたファイルを含むフォルダーへの相対パスまたは絶対パス。
IgnoreCheck [in]
パッケージが追加されたときに実行される内部適用性チェックを無視するかどうかを指定するブール値。
| Value | 説明 |
|---|---|
| TRUE | 内部適用性チェックを無視します。 |
| FALSE | 内部適用性チェックを無視しません。 |
PreventPending [in]
保留中のオンライン アクションがある場合にパッケージを追加するかどうかを指定するブール値。
| Value | 説明 |
|---|---|
| TRUE | 保留中のオンライン操作を含むパッケージをインストールしないようにします。 |
| FALSE | 保留中のオンライン操作を含むパッケージのインストールを許可します。 |
CancelEvent [in、オプション]
任意。 この関数に対して CancelEvent を設定すると、クライアントからシグナルが送信されたときに進行中の操作をキャンセルできます。 操作をキャンセルできない段階で CancelEvent を受信した場合、操作は続行され、成功コードが返されます。 CancelEvent を受信し、操作がキャンセルされた場合、イメージの状態は不明です。 続行する前にイメージの状態を確認するか、変更を破棄してからもう一度開始する必要があります。
Progress [in、オプション]
任意。 クライアント定義の DismProgressCallback へのポインター。
UserData [in、オプション]
任意。 ユーザー定義のカスタム データ。
戻り値
成功すると S_OK が返されます。
解説
オンライン イメージに追加できるのは、.cab ファイルだけです。 オフライン イメージには .cab または .msu ファイルのいずれも追加できます。
パッケージが適用できない場合、この関数は特殊なエラー コードを返します。 DismGetPackageInfo を使用すると、パッケージが対象イメージに適用できるかどうかを判断できます。
例
HRESULT hr = S_OK;
hr = DismAddPackage(Session, "C:\\packages\\calc.cab", FALSE, FALSE, NULL, NULL, NULL);
必要条件
| 要件 | 説明 |
|---|---|
| サポートされているホスト プラットフォーム | DISM API は、Windows アセスメント & デプロイメント キット (Windows ADK) でサポートされているすべてのオペレーティング システムで使用できます。 詳細については、Windows ADK のテクニカル リファレンスに関するページを参照してください。 |
| サポートされているイメージ プラットフォーム | 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 |