MsiDeterminePatchSequenceA 関数 (msi.h)
MsiDeterminePatchSequence 関数は、一連のパッチ ファイル、XML ファイル、および XML BLOB を受け取り、指定されたインストール済み製品に対するパッチの最適なアプリケーション シーケンスを決定します。 この関数は、製品に既に適用されているパッチを説明し、古いパッチと置き換えられたパッチを考慮します。
構文
UINT MsiDeterminePatchSequenceA(
[in] LPCSTR szProductCode,
[in, optional] LPCSTR szUserSid,
[in] MSIINSTALLCONTEXT dwContext,
[in] DWORD cPatchInfo,
[in] PMSIPATCHSEQUENCEINFOA pPatchInfo
);
パラメーター
[in] szProductCode
パッチのセットのターゲットである製品。 値は、製品の ProductCode GUID である必要があります。
[in, optional] szUserSid
ユーザーのセキュリティ識別子 (SID) を指定する Null で終わる文字列。 このパラメーターは、このユーザー アカウントの列挙のコンテキストを制限します。 このパラメーターは、特殊な SID 文字列 "S-1-1-0" (すべてのユーザー) または "S-1-5-18" (ローカル システム) にすることはできません。 コンピューター コンテキスト dwContext が MSIINSTALLCONTEXT_MACHINE に設定され、 szUserSid が NULL である必要があります。 現在のユーザー コンテキスト の場合、szUserSid は null に設定でき、 dwContext は MSIINSTALLCONTEXT_USERMANAGED または MSIINSTALLCONTEXT_USERUNMANAGEDに設定できます。
[in] dwContext
列挙を、ユーザーごとのアンマネージド、ユーザーごとの管理、またはマシンごとのコンテキストに制限します。 このパラメーターには、次のいずれかの値を指定できます。
[in] cPatchInfo
配列内のパッチの数。
[in] pPatchInfo
MSIPATCHSEQUENCEINFO 構造体の配列へのポインター。
戻り値
MsiDeterminePatchSequence 関数は、次の値を返します。
| 値 | 説明 |
|---|---|
|
関数は、他のエラー コードでは説明されていない方法で失敗しました。 |
|
引数が無効です。 |
|
一連の修正プログラムに有効なシーケンスが見つかりませんでした。 |
|
パスによって参照されるインストール パッケージを開くことができません。 |
|
パッチは正常に並べ替えられました。 |
|
.msi ファイルが見つかりませんでした。 |
|
.msi ファイルへのパスが見つかりませんでした。 |
|
XML 修正プログラム データが無効です。 |
|
インストール パッケージが無効です。 |
|
管理者ではないユーザーが、別のユーザーのコンテキストで関数を呼び出そうとしました。 |
|
登録済みのパッチまたは製品の構成データが無効です。 |
|
指定された ProductCode GUID は登録されていません。 |
|
最適なパッチ シーケンスを決定するには、Windows インストーラー バージョン 3.0 が必要です。 この関数は、Windows インストーラー バージョン 3.0 でまだインストールされていない szProductCode で呼び出されました。 |
|
このエラーは、関数が カスタム アクション から呼び出された場合、または MSXML 3.0 がインストールされていない場合に返されることがあります。 |
|
指定されたパッチが不明です。 |
解説
管理者特権を持たないユーザーは、自分またはコンピューターのコンテキストでのみこの関数を呼び出すことができます。 管理者であるユーザーは、他のユーザーに対して呼び出すことができます。
この関数がカスタム アクションから呼び出されると、失敗し 、ERROR_CALL_NOT_IMPLEMENTEDが返されます。 関数は、XML を処理するために MSXML バージョン 3.0 を必要とし、MSXML 3.0 がインストールされていない場合は ERROR_CALL_NOT_IMPLEMENTED を返します。
MsiDeterminePatchSequence 関数は、pPatchInfo が指す各 MSIPATCHSEQUENCEINFO 構造体の uStatus メンバーと dwOrder メンバーを設定します。 各構造体には、特定のパッチに関する情報が含まれています。
関数が成功した場合、製品に適用できるすべてのパッチの MSIPATCHSEQUENCEINFO 構造体は、 uStatusが ERROR_SUCCESS で 、dwOrder が 0 以上で返されます。 0 以上の dwOrder の値は、0 から始まるパッチに最適なアプリケーション シーケンスを示します。
関数が成功した場合、最適な修正プログラムシーケンスから除外されたパッチは、-1 と等しい dwOrder を持つ MSIPATCHSEQUENCEINFO 構造体を返します。 このような場合、ERROR_SUCCESS の uStatus フィールドは、製品の古いパッチまたは置き換えられたパッチを示します。 ERROR_PATCH_TARGET_NOT_FOUND の uStatus フィールドは、製品に適用できないパッチを示します。
関数が失敗した場合、すべてのパッチの MSIPATCHSEQUENCEINFO 構造体は-1 と等しい dwOrder を返します。 この場合、 uStatus フィールドには、個々のパッチに関する詳細情報を含むエラーが含まれている可能性があります。 たとえば 、ERROR_PATCH_NO_SEQUENCE は、循環シーケンス情報を持つパッチに対して返されます。
注意
msi.h ヘッダーは、MSIDeterminePatchSequence をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| サポートされている最小のクライアント | Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows インストーラーのバージョンで必要な最小 Windows サービス パックに関する情報については、Windows インストーラーの実行時の要件に関する記事を参照してください。 |
| 対象プラットフォーム | Windows |
| ヘッダー | msi.h |
| Library | Msi.lib |
| [DLL] | Msi.dll |