ホーム › System.ApplicationInstallationAndServicing › MsiDeterminePatchSequenceW

MsiDeterminePatchSequenceW

関数

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

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

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDeterminePatchSequenceW(
    LPCWSTR szProductCode,
    LPCWSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOW* pPatchInfo
);

パラメーター

名前

型

方向

説明

szProductCode

LPCWSTR

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

szUserSid

LPCWSTR

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

MSIPATCHSEQUENCEINFOW*

inout

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

戻り値の型: DWORD

公式ドキュメント

パッチファイル、XML ファイル、XML BLOB の集合を受け取り、指定されたインストール済み製品に対してパッチを適用する最適な順序を決定します。(Unicode)

戻り値

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 ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiDeterminePatchSequence を定義しています。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながることがあります。詳細については、「関数プロトタイプの規則」を参照してください。

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiDeterminePatchSequenceW(
    LPCWSTR szProductCode,
    LPCWSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOW* pPatchInfo
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDeterminePatchSequenceW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProductCode,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szUserSid,   // LPCWSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    uint cPatchInfo,   // DWORD
    IntPtr pPatchInfo   // MSIPATCHSEQUENCEINFOW* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiDeterminePatchSequenceW(
    <MarshalAs(UnmanagedType.LPWStr)> szProductCode As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szUserSid As String,   ' LPCWSTR optional
    dwContext As Integer,   ' MSIINSTALLCONTEXT
    cPatchInfo As UInteger,   ' DWORD
    pPatchInfo As IntPtr   ' MSIPATCHSEQUENCEINFOW* in/out
) As UInteger
End Function

' szProductCode : LPCWSTR
' szUserSid : LPCWSTR optional
' dwContext : MSIINSTALLCONTEXT
' cPatchInfo : DWORD
' pPatchInfo : MSIPATCHSEQUENCEINFOW* in/out
Declare PtrSafe Function MsiDeterminePatchSequenceW Lib "msi" ( _
    ByVal szProductCode As LongPtr, _
    ByVal szUserSid As LongPtr, _
    ByVal dwContext As Long, _
    ByVal cPatchInfo As Long, _
    ByVal pPatchInfo As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDeterminePatchSequenceW = Fiddle::Function.new(
  lib['MsiDeterminePatchSequenceW'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCWSTR optional
    Fiddle::TYPE_INT,  # dwContext : MSIINSTALLCONTEXT
    -Fiddle::TYPE_INT,  # cPatchInfo : DWORD
    Fiddle::TYPE_VOIDP,  # pPatchInfo : MSIPATCHSEQUENCEINFOW* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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