ホーム › System.ApplicationInstallationAndServicing › MsiDetermineApplicablePatchesW

MsiDetermineApplicablePatchesW

関数

製品に適用可能なパッチを判定する(Unicode版)。

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

シグネチャ

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

DWORD MsiDetermineApplicablePatchesW(
    LPCWSTR szProductPackagePath,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOW* pPatchInfo
);

パラメーター

名前	型	方向	説明
szProductPackagePath	LPCWSTR	in	.msi ファイルへのフルパス。関数は、このパッケージに適用可能なパッチと、その適用順序を判定します。
cPatchInfo	DWORD	in	配列内のパッチの数。0 より大きい値である必要があります。
pPatchInfo	MSIPATCHSEQUENCEINFOW*	inout	MSIPATCHSEQUENCEINFO 構造体の配列へのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiDetermineApplicablePatches 関数は、パッチファイル、XML ファイル、XML BLOB の集合を受け取り、指定された Windows Installer パッケージに適用可能なパッチと、その適用順序を判定します。(Unicode)

戻り値

                <b>MsiDetermineApplicablePatches</b> 関数は、次の値を返します。

値	意味
ERROR_FUNCTION_FAILED	他のエラーコードでは扱われない形で関数が失敗しました。
ERROR_INVALID_PARAMETER	引数が無効です。
ERROR_PATCH_NO_SEQUENCE	パッチの集合に対して有効なシーケンスが見つかりませんでした。
ERROR_SUCCESS	パッチが正常に並べ替えられました。
ERROR_FILE_NOT_FOUND	.msi ファイルが見つかりませんでした。
ERROR_PATH_NOT_FOUND	.msi ファイルへのパスが見つかりませんでした。
ERROR_INVALID_PATCH_XML	XML パッチデータが無効です。
ERROR_INSTALL_PACKAGE_OPEN_FAILED	パスで参照されているインストールパッケージを開けません。
ERROR_CALL_NOT_IMPLEMENTED	このエラーは、関数がカスタムアクションから呼び出された場合、または MSXML 3.0 がインストールされていない場合に返されることがあります。

解説(Remarks)

この関数がカスタムアクションから呼び出された場合は失敗し、ERROR_CALL_NOT_IMPLEMENTED を返します。この関数は XML を処理するために MSXML バージョン 3.0 を必要とし、MSXML 3.0 がインストールされていない場合は ERROR_CALL_NOT_IMPLEMENTED を返します。

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiDetermineApplicablePatchesW(
    LPCWSTR szProductPackagePath,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOW* pPatchInfo
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDetermineApplicablePatchesW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProductPackagePath,   // LPCWSTR
    uint cPatchInfo,   // DWORD
    IntPtr pPatchInfo   // MSIPATCHSEQUENCEINFOW* in/out
);

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

' szProductPackagePath : LPCWSTR
' cPatchInfo : DWORD
' pPatchInfo : MSIPATCHSEQUENCEINFOW* in/out
Declare PtrSafe Function MsiDetermineApplicablePatchesW Lib "msi" ( _
    ByVal szProductPackagePath As LongPtr, _
    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

MsiDetermineApplicablePatchesW = ctypes.windll.msi.MsiDetermineApplicablePatchesW
MsiDetermineApplicablePatchesW.restype = wintypes.DWORD
MsiDetermineApplicablePatchesW.argtypes = [
    wintypes.LPCWSTR,  # szProductPackagePath : LPCWSTR
    wintypes.DWORD,  # cPatchInfo : DWORD
    ctypes.c_void_p,  # pPatchInfo : MSIPATCHSEQUENCEINFOW* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDetermineApplicablePatchesW = Fiddle::Function.new(
  lib['MsiDetermineApplicablePatchesW'],
  [
    Fiddle::TYPE_VOIDP,  # szProductPackagePath : LPCWSTR
    -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 MsiDetermineApplicablePatchesW(
        szProductPackagePath: *const u16,  // LPCWSTR
        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 MsiDetermineApplicablePatchesW([MarshalAs(UnmanagedType.LPWStr)] string szProductPackagePath, uint cPatchInfo, IntPtr pPatchInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDetermineApplicablePatchesW' -Namespace Win32 -PassThru
# $api::MsiDetermineApplicablePatchesW(szProductPackagePath, cPatchInfo, pPatchInfo)

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

出力引数:

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