ホーム › System.ApplicationInstallationAndServicing › MsiDeterminePatchSequenceA

MsiDeterminePatchSequenceA

関数

パッチの適用順序を判定する(ANSI版)。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDeterminePatchSequenceA(
    LPCSTR szProductCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOA* pPatchInfo
);

パラメーター

名前

型

方向

説明

szProductCode

LPCSTR

パッチセットの適用対象となる製品です。値は、その製品の ProductCode GUID でなければなりません。

szUserSid

LPCSTR

inoptional

ユーザーのセキュリティ識別子 (SID) を指定する null 終端文字列です。このパラメーターは、列挙のコンテキストをこのユーザーアカウントに制限します。このパラメーターに、特殊な SID 文字列 "S-1-1-0" (everyone) または "S-1-5-18" (local system) を指定することはできません。マシンコンテキストの場合は dwContext を MSIINSTALLCONTEXT_MACHINE に設定し、szUserSid は NULL でなければなりません。現在のユーザーコンテキストの場合は、szUserSid を null にでき、dwContext を MSIINSTALLCONTEXT_USERMANAGED または MSIINSTALLCONTEXT_USERUNMANAGED に設定できます。

dwContext

MSIINSTALLCONTEXT

列挙を、ユーザー単位 (非管理)、ユーザー単位 (管理)、またはマシン単位のいずれかのコンテキストに制限します。このパラメーターには、次のいずれかの値を指定できます。

コンテキストの種類	意味
MSIINSTALLCONTEXT_USERMANAGED	szUserSid で指定されたユーザーに対する、製品のすべてのユーザー単位 (管理) インストールについてパッチが考慮されます。このコンテキストで szUserSid を null にすると、現在のユーザーを意味します。
MSIINSTALLCONTEXT_USERUNMANAGED	szUserSid で指定されたユーザーに対する、すべてのユーザー単位 (非管理) インストールについてパッチが考慮されます。このコンテキストで szUserSid を null にすると、現在のユーザーを意味します。
MSIINSTALLCONTEXT_MACHINE	マシン単位のインストールについてパッチが考慮されます。dwContext を MSIINSTALLCONTEXT_MACHINE に設定する場合、szUserSid パラメーターは null でなければなりません。

cPatchInfo

DWORD

配列内のパッチ数です。

pPatchInfo

MSIPATCHSEQUENCEINFOA*

inout

MSIPATCHSEQUENCEINFO 構造体の配列へのポインターです。

戻り値の型: DWORD

公式ドキュメント

パッチファイル、XML ファイル、および XML BLOB のセットを受け取り、指定したインストール済み製品にパッチを適用する最適な順序を決定します。(ANSI)

戻り値

MsiDeterminePatchSequence 関数は、次の値を返します。

値	意味
ERROR_FUNCTION_FAILED	他のエラーコードでカバーされない形で関数が失敗しました。
ERROR_INVALID_PARAMETER	引数が無効です。
ERROR_PATCH_NO_SEQUENCE	パッチセットに対する有効な順序が見つかりませんでした。
ERROR_INSTALL_PACKAGE_OPEN_FAILED	パスで参照されているインストールパッケージを開くことができません。
ERROR_SUCCESS	パッチが正常に並べ替えられました。
ERROR_FILE_NOT_FOUND	.msi ファイルが見つかりませんでした。
ERROR_PATH_NOT_FOUND	.msi ファイルへのパスが見つかりませんでした。
ERROR_INVALID_PATCH_XML	XML パッチデータが無効です。
ERROR_INSTALL_PACKAGE_INVALID	インストールパッケージが無効でした。
ERROR_ACCESS_DENIED	管理者でないユーザーが、別のユーザーのコンテキストでこの関数を呼び出そうとしました。
ERROR_BAD_CONFIGURATION	登録済みのパッチまたは製品の構成データが無効です。
ERROR_UNKNOWN_PRODUCT	指定された ProductCode GUID が登録されていません。
ERROR_FUNCTION_NOT_CALLED	最適なパッチ順序を決定するには Windows Installer バージョン 3.0 が必要です。Windows Installer バージョン 3.0 でまだインストールされていない szProductCode を指定して関数が呼び出されました。
ERROR_CALL_NOT_IMPLEMENTED	このエラーは、関数がカスタムアクションから呼び出された場合、または MSXML 3.0 がインストールされていない場合に返されることがあります。
ERROR_UNKNOWN_PATCH	指定されたパッチが不明です。

解説(Remarks)

管理者権限を持たないユーザーは、自分自身のコンテキストまたはマシンコンテキストでのみこの関数を呼び出すことができます。管理者であるユーザーは、他のユーザーに対しても呼び出すことができます。

この関数をカスタムアクションから呼び出すと失敗し、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 から始まるパッチの最適な適用順序を示します。

関数が成功した場合、最適なパッチ順序から除外されたパッチは、dwOrder が -1 の MSIPATCHSEQUENCEINFO 構造体を返します。これらの場合、uStatus フィールドが ERROR_SUCCESS であれば、その製品に対して廃止されたか上書きされたパッチであることを示します。uStatus フィールドが ERROR_PATCH_TARGET_NOT_FOUND であれば、その製品に適用できないパッチであることを示します。

関数が失敗した場合、すべてのパッチの MSIPATCHSEQUENCEINFO 構造体は dwOrder が -1 で返されます。この場合、uStatus フィールドには、個々のパッチに関する詳細情報を含むエラーが格納されることがあります。たとえば、循環した順序情報を持つパッチには ERROR_PATCH_NO_SEQUENCE が返されます。

メモ

msi.h ヘッダーは、MsiDeterminePatchSequence を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不一致につながる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiDeterminePatchSequenceA(
    LPCSTR szProductCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOA* pPatchInfo
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDeterminePatchSequenceA(
    [MarshalAs(UnmanagedType.LPStr)] string szProductCode,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szUserSid,   // LPCSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    uint cPatchInfo,   // DWORD
    IntPtr pPatchInfo   // MSIPATCHSEQUENCEINFOA* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDeterminePatchSequenceA(
    <MarshalAs(UnmanagedType.LPStr)> szProductCode As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szUserSid As String,   ' LPCSTR optional
    dwContext As Integer,   ' MSIINSTALLCONTEXT
    cPatchInfo As UInteger,   ' DWORD
    pPatchInfo As IntPtr   ' MSIPATCHSEQUENCEINFOA* in/out
) As UInteger
End Function

' szProductCode : LPCSTR
' szUserSid : LPCSTR optional
' dwContext : MSIINSTALLCONTEXT
' cPatchInfo : DWORD
' pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
Declare PtrSafe Function MsiDeterminePatchSequenceA Lib "msi" ( _
    ByVal szProductCode As String, _
    ByVal szUserSid As String, _
    ByVal dwContext As Long, _
    ByVal cPatchInfo As Long, _
    ByVal pPatchInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiDeterminePatchSequenceA = ctypes.windll.msi.MsiDeterminePatchSequenceA
MsiDeterminePatchSequenceA.restype = wintypes.DWORD
MsiDeterminePatchSequenceA.argtypes = [
    wintypes.LPCSTR,  # szProductCode : LPCSTR
    wintypes.LPCSTR,  # szUserSid : LPCSTR optional
    ctypes.c_int,  # dwContext : MSIINSTALLCONTEXT
    wintypes.DWORD,  # cPatchInfo : DWORD
    ctypes.c_void_p,  # pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDeterminePatchSequenceA = Fiddle::Function.new(
  lib['MsiDeterminePatchSequenceA'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCSTR optional
    Fiddle::TYPE_INT,  # dwContext : MSIINSTALLCONTEXT
    -Fiddle::TYPE_INT,  # cPatchInfo : DWORD
    Fiddle::TYPE_VOIDP,  # pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiDeterminePatchSequenceA(
        szProductCode: *const u8,  // LPCSTR
        szUserSid: *const u8,  // LPCSTR optional
        dwContext: i32,  // MSIINSTALLCONTEXT
        cPatchInfo: u32,  // DWORD
        pPatchInfo: *mut MSIPATCHSEQUENCEINFOA  // MSIPATCHSEQUENCEINFOA* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiDeterminePatchSequenceA([MarshalAs(UnmanagedType.LPStr)] string szProductCode, [MarshalAs(UnmanagedType.LPStr)] string szUserSid, int dwContext, uint cPatchInfo, IntPtr pPatchInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDeterminePatchSequenceA' -Namespace Win32 -PassThru
# $api::MsiDeterminePatchSequenceA(szProductCode, szUserSid, dwContext, cPatchInfo, pPatchInfo)

#uselib "msi.dll"
#func global MsiDeterminePatchSequenceA "MsiDeterminePatchSequenceA" sptr, sptr, sptr, sptr, sptr
; MsiDeterminePatchSequenceA szProductCode, szUserSid, dwContext, cPatchInfo, varptr(pPatchInfo)   ; 戻り値は stat
; szProductCode : LPCSTR -> "sptr"
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : MSIINSTALLCONTEXT -> "sptr"
; cPatchInfo : DWORD -> "sptr"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiDeterminePatchSequenceA "MsiDeterminePatchSequenceA" str, str, int, int, var
; res = MsiDeterminePatchSequenceA(szProductCode, szUserSid, dwContext, cPatchInfo, pPatchInfo)
; szProductCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; cPatchInfo : DWORD -> "int"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiDeterminePatchSequenceA "MsiDeterminePatchSequenceA" str, str, int, int, sptr
; res = MsiDeterminePatchSequenceA(szProductCode, szUserSid, dwContext, cPatchInfo, varptr(pPatchInfo))
; szProductCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; cPatchInfo : DWORD -> "int"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。