Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiDetermineApplicablePatchesA

MsiDetermineApplicablePatchesA

関数
製品に適用可能なパッチを判定する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiDetermineApplicablePatchesA(
    LPCSTR szProductPackagePath,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOA* pPatchInfo
);

パラメーター

名前方向説明
szProductPackagePathLPCSTRin.msi ファイルへのフルパス。この関数は、このパッケージに適用可能なパッチとその適用順序を判別します。
cPatchInfoDWORDin配列内のパッチの数。0 より大きくなければなりません。
pPatchInfoMSIPATCHSEQUENCEINFOA*inoutMSIPATCHSEQUENCEINFO 構造体の配列へのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiDetermineApplicablePatches 関数は、パッチファイル、XML ファイル、および XML BLOB のセットを受け取り、指定された Windows Installer パッケージに対してどのパッチがどの順序で適用されるかを判別します。(ANSI)

戻り値

                <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 構造体は、uStatusERROR_SUCCESSdwOrder に 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 版を自動的に選択するエイリアスとして MsiDetermineApplicablePatches を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiDetermineApplicablePatchesA(
    LPCSTR szProductPackagePath,
    DWORD cPatchInfo,
    MSIPATCHSEQUENCEINFOA* pPatchInfo
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDetermineApplicablePatchesA(
    [MarshalAs(UnmanagedType.LPStr)] string szProductPackagePath,   // LPCSTR
    uint cPatchInfo,   // DWORD
    IntPtr pPatchInfo   // MSIPATCHSEQUENCEINFOA* in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDetermineApplicablePatchesA(
    <MarshalAs(UnmanagedType.LPStr)> szProductPackagePath As String,   ' LPCSTR
    cPatchInfo As UInteger,   ' DWORD
    pPatchInfo As IntPtr   ' MSIPATCHSEQUENCEINFOA* in/out
) As UInteger
End Function
' szProductPackagePath : LPCSTR
' cPatchInfo : DWORD
' pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
Declare PtrSafe Function MsiDetermineApplicablePatchesA Lib "msi" ( _
    ByVal szProductPackagePath As String, _
    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

MsiDetermineApplicablePatchesA = ctypes.windll.msi.MsiDetermineApplicablePatchesA
MsiDetermineApplicablePatchesA.restype = wintypes.DWORD
MsiDetermineApplicablePatchesA.argtypes = [
    wintypes.LPCSTR,  # szProductPackagePath : LPCSTR
    wintypes.DWORD,  # cPatchInfo : DWORD
    ctypes.c_void_p,  # pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDetermineApplicablePatchesA = Fiddle::Function.new(
  lib['MsiDetermineApplicablePatchesA'],
  [
    Fiddle::TYPE_VOIDP,  # szProductPackagePath : LPCSTR
    -Fiddle::TYPE_INT,  # cPatchInfo : DWORD
    Fiddle::TYPE_VOIDP,  # pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiDetermineApplicablePatchesA(
        szProductPackagePath: *const u8,  // LPCSTR
        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 MsiDetermineApplicablePatchesA([MarshalAs(UnmanagedType.LPStr)] string szProductPackagePath, uint cPatchInfo, IntPtr pPatchInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDetermineApplicablePatchesA' -Namespace Win32 -PassThru
# $api::MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
#uselib "msi.dll"
#func global MsiDetermineApplicablePatchesA "MsiDetermineApplicablePatchesA" sptr, sptr, sptr
; MsiDetermineApplicablePatchesA szProductPackagePath, cPatchInfo, varptr(pPatchInfo)   ; 戻り値は stat
; szProductPackagePath : LPCSTR -> "sptr"
; cPatchInfo : DWORD -> "sptr"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiDetermineApplicablePatchesA "MsiDetermineApplicablePatchesA" str, int, var
; res = MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
; szProductPackagePath : LPCSTR -> "str"
; cPatchInfo : DWORD -> "int"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiDetermineApplicablePatchesA(LPCSTR szProductPackagePath, DWORD cPatchInfo, MSIPATCHSEQUENCEINFOA* pPatchInfo)
#uselib "msi.dll"
#cfunc global MsiDetermineApplicablePatchesA "MsiDetermineApplicablePatchesA" str, int, var
; res = MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
; szProductPackagePath : LPCSTR -> "str"
; cPatchInfo : DWORD -> "int"
; pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDetermineApplicablePatchesA = msi.NewProc("MsiDetermineApplicablePatchesA")
)

// szProductPackagePath (LPCSTR), cPatchInfo (DWORD), pPatchInfo (MSIPATCHSEQUENCEINFOA* in/out)
r1, _, err := procMsiDetermineApplicablePatchesA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szProductPackagePath))),
	uintptr(cPatchInfo),
	uintptr(pPatchInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiDetermineApplicablePatchesA(
  szProductPackagePath: PAnsiChar;   // LPCSTR
  cPatchInfo: DWORD;   // DWORD
  pPatchInfo: Pointer   // MSIPATCHSEQUENCEINFOA* in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDetermineApplicablePatchesA';
result := DllCall("msi\MsiDetermineApplicablePatchesA"
    , "AStr", szProductPackagePath   ; LPCSTR
    , "UInt", cPatchInfo   ; DWORD
    , "Ptr", pPatchInfo   ; MSIPATCHSEQUENCEINFOA* in/out
    , "UInt")   ; return: DWORD
●MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo) = DLL("msi.dll", "dword MsiDetermineApplicablePatchesA(char*, dword, void*)")
# 呼び出し: MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
# szProductPackagePath : LPCSTR -> "char*"
# cPatchInfo : DWORD -> "dword"
# pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiDetermineApplicablePatchesA(
    szProductPackagePath: [*c]const u8, // LPCSTR
    cPatchInfo: u32, // DWORD
    pPatchInfo: [*c]MSIPATCHSEQUENCEINFOA // MSIPATCHSEQUENCEINFOA* in/out
) callconv(std.os.windows.WINAPI) u32;
proc MsiDetermineApplicablePatchesA(
    szProductPackagePath: cstring,  # LPCSTR
    cPatchInfo: uint32,  # DWORD
    pPatchInfo: ptr MSIPATCHSEQUENCEINFOA  # MSIPATCHSEQUENCEINFOA* in/out
): uint32 {.importc: "MsiDetermineApplicablePatchesA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiDetermineApplicablePatchesA(
    const(char)* szProductPackagePath,   // LPCSTR
    uint cPatchInfo,   // DWORD
    MSIPATCHSEQUENCEINFOA* pPatchInfo   // MSIPATCHSEQUENCEINFOA* in/out
);
ccall((:MsiDetermineApplicablePatchesA, "msi.dll"), stdcall, UInt32,
      (Cstring, UInt32, Ptr{MSIPATCHSEQUENCEINFOA}),
      szProductPackagePath, cPatchInfo, pPatchInfo)
# szProductPackagePath : LPCSTR -> Cstring
# cPatchInfo : DWORD -> UInt32
# pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> Ptr{MSIPATCHSEQUENCEINFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiDetermineApplicablePatchesA(
    const char* szProductPackagePath,
    uint32_t cPatchInfo,
    void* pPatchInfo);
]]
local msi = ffi.load("msi")
-- msi.MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
-- szProductPackagePath : LPCSTR
-- cPatchInfo : DWORD
-- pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiDetermineApplicablePatchesA = lib.func('__stdcall', 'MsiDetermineApplicablePatchesA', 'uint32_t', ['str', 'uint32_t', 'void *']);
// MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
// szProductPackagePath : LPCSTR -> 'str'
// cPatchInfo : DWORD -> 'uint32_t'
// pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiDetermineApplicablePatchesA: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo)
// szProductPackagePath : LPCSTR -> "buffer"
// cPatchInfo : DWORD -> "u32"
// pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiDetermineApplicablePatchesA(
    const char* szProductPackagePath,
    uint32_t cPatchInfo,
    void* pPatchInfo);
C, "msi.dll");
// $ffi->MsiDetermineApplicablePatchesA(szProductPackagePath, cPatchInfo, pPatchInfo);
// szProductPackagePath : LPCSTR
// cPatchInfo : DWORD
// pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.ASCII_OPTIONS);
    int MsiDetermineApplicablePatchesA(
        String szProductPackagePath,   // LPCSTR
        int cPatchInfo,   // DWORD
        Pointer pPatchInfo   // MSIPATCHSEQUENCEINFOA* in/out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiDetermineApplicablePatchesA = MsiDetermineApplicablePatchesA(
    szProductPackagePath : UInt8*,   # LPCSTR
    cPatchInfo : UInt32,   # DWORD
    pPatchInfo : MSIPATCHSEQUENCEINFOA*   # MSIPATCHSEQUENCEINFOA* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiDetermineApplicablePatchesANative = Uint32 Function(Pointer<Utf8>, Uint32, Pointer<Void>);
typedef MsiDetermineApplicablePatchesADart = int Function(Pointer<Utf8>, int, Pointer<Void>);
final MsiDetermineApplicablePatchesA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiDetermineApplicablePatchesANative, MsiDetermineApplicablePatchesADart>('MsiDetermineApplicablePatchesA');
// szProductPackagePath : LPCSTR -> Pointer<Utf8>
// cPatchInfo : DWORD -> Uint32
// pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiDetermineApplicablePatchesA(
  szProductPackagePath: PAnsiChar;   // LPCSTR
  cPatchInfo: DWORD;   // DWORD
  pPatchInfo: Pointer   // MSIPATCHSEQUENCEINFOA* in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDetermineApplicablePatchesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiDetermineApplicablePatchesA"
  c_MsiDetermineApplicablePatchesA :: CString -> Word32 -> Ptr () -> IO Word32
-- szProductPackagePath : LPCSTR -> CString
-- cPatchInfo : DWORD -> Word32
-- pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msidetermineapplicablepatchesa =
  foreign "MsiDetermineApplicablePatchesA"
    (string @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* szProductPackagePath : LPCSTR -> string *)
(* cPatchInfo : DWORD -> uint32_t *)
(* pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiDetermineApplicablePatchesA" msi-determine-applicable-patches-a :convention :stdcall) :uint32
  (sz-product-package-path :string)   ; LPCSTR
  (c-patch-info :uint32)   ; DWORD
  (p-patch-info :pointer))   ; MSIPATCHSEQUENCEINFOA* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiDetermineApplicablePatchesA = Win32::API::More->new('msi',
    'DWORD MsiDetermineApplicablePatchesA(LPCSTR szProductPackagePath, DWORD cPatchInfo, LPVOID pPatchInfo)');
# my $ret = $MsiDetermineApplicablePatchesA->Call($szProductPackagePath, $cPatchInfo, $pPatchInfo);
# szProductPackagePath : LPCSTR -> LPCSTR
# cPatchInfo : DWORD -> DWORD
# pPatchInfo : MSIPATCHSEQUENCEINFOA* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型