ホーム › System.ApplicationInstallationAndServicing › MsiExtractPatchXMLDataA

MsiExtractPatchXMLDataA

関数

パッチパッケージからXMLメタデータを抽出する(ANSI版)。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD MsiExtractPatchXMLDataA(
    LPCSTR szPatchPath,
    DWORD dwReserved,   // optional
    LPSTR szXMLData,   // optional
    DWORD* pcchXMLData   // optional
);

パラメーター

名前	型	方向	説明
szPatchPath	LPCSTR	in	クエリ対象となるパッチへのフルパス。null で終わる文字列として渡します。このパラメーターを NULL にすることはできません。
dwReserved	DWORD	optional	予約された引数であり、0 (ゼロ) を指定する必要があります。
szXMLData	LPSTR	outoptional	抽出されたパッチ情報を含む XML 文字列を格納するバッファーへのポインター。このバッファーは、受け取る情報を格納できる十分な大きさである必要があります。バッファーが小さすぎる場合、関数は ERROR_MORE_DATA を返し、*pcchXMLData に、終端の NULL 文字を含まない値の TCHAR 数を設定します。 szXMLData が NULL に設定され、pcchXMLData が有効なポインターに設定されている場合、関数は ERROR_SUCCESS を返し、pcchXMLData に、終端の NULL 文字を含まない値の TCHAR 数を設定します。その後、pcchXMLData + 1 文字を格納できる十分な大きさの szXMLData バッファーを指定して関数を再度呼び出すことで、値を取得できます。
pcchXMLData	DWORD*	inoutoptional	szXMLData バッファー内の TCHAR 数を指定する変数へのポインター。関数が戻るとき、このパラメーターには、関数が値を指定されたバッファーにコピーしたかどうかにかかわらず、要求された値のサイズが設定されます。サイズは、終端の null 文字を含まない、要求された値の TCHAR 数として返されます。このパラメーターが NULL に設定されている場合、関数は ERROR_INVALID_PARAMETER を返します。

戻り値の型: DWORD

公式ドキュメント

MsiExtractPatchXMLData 関数は、パッチがターゲットシステムに適用可能かどうかを判定するために使用できる情報を、パッチから抽出します。(ANSI)

戻り値

MsiExtractPatchXMLData 関数は、次の値を返すことがあります。

戻り値	説明
ERROR_FUNCTION_FAILED	この表のいずれの戻り値でも特定できない方法で、関数が失敗しました。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_MORE_DATA	値が、指定されたバッファーに収まりません。
ERROR_PATCH_OPEN_FAILED	パッチファイルを開けませんでした。
ERROR_SUCCESS	関数は成功しました。
ERROR_PATCH_PACKAGE_INVALID	パッチファイルを開けませんでした。
ERROR_CALL_NOT_IMPLEMENTED	このエラーは、MSXML 3.0 がインストールされていない場合に返されることがあります。

解説(Remarks)

Installer オブジェクトの ExtractPatchXMLData メソッドは、MsiExtractPatchXMLData 関数を使用します。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiExtractPatchXMLData を定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiExtractPatchXMLDataA(
    LPCSTR szPatchPath,
    DWORD dwReserved,   // optional
    LPSTR szXMLData,   // optional
    DWORD* pcchXMLData   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiExtractPatchXMLDataA(
    [MarshalAs(UnmanagedType.LPStr)] string szPatchPath,   // LPCSTR
    uint dwReserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szXMLData,   // LPSTR optional, out
    IntPtr pcchXMLData   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiExtractPatchXMLDataA(
    <MarshalAs(UnmanagedType.LPStr)> szPatchPath As String,   ' LPCSTR
    dwReserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPStr)> szXMLData As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchXMLData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szPatchPath : LPCSTR
' dwReserved : DWORD optional
' szXMLData : LPSTR optional, out
' pcchXMLData : DWORD* optional, in/out
Declare PtrSafe Function MsiExtractPatchXMLDataA Lib "msi" ( _
    ByVal szPatchPath As String, _
    ByVal dwReserved As Long, _
    ByVal szXMLData As String, _
    ByVal pcchXMLData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiExtractPatchXMLDataA = ctypes.windll.msi.MsiExtractPatchXMLDataA
MsiExtractPatchXMLDataA.restype = wintypes.DWORD
MsiExtractPatchXMLDataA.argtypes = [
    wintypes.LPCSTR,  # szPatchPath : LPCSTR
    wintypes.DWORD,  # dwReserved : DWORD optional
    wintypes.LPSTR,  # szXMLData : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchXMLData : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiExtractPatchXMLDataA = Fiddle::Function.new(
  lib['MsiExtractPatchXMLDataA'],
  [
    Fiddle::TYPE_VOIDP,  # szPatchPath : LPCSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # szXMLData : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchXMLData : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiExtractPatchXMLDataA(
        szPatchPath: *const u8,  // LPCSTR
        dwReserved: u32,  // DWORD optional
        szXMLData: *mut u8,  // LPSTR optional, out
        pcchXMLData: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiExtractPatchXMLDataA([MarshalAs(UnmanagedType.LPStr)] string szPatchPath, uint dwReserved, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szXMLData, IntPtr pcchXMLData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiExtractPatchXMLDataA' -Namespace Win32 -PassThru
# $api::MsiExtractPatchXMLDataA(szPatchPath, dwReserved, szXMLData, pcchXMLData)

#uselib "msi.dll"
#func global MsiExtractPatchXMLDataA "MsiExtractPatchXMLDataA" sptr, sptr, sptr, sptr
; MsiExtractPatchXMLDataA szPatchPath, dwReserved, varptr(szXMLData), varptr(pcchXMLData)   ; 戻り値は stat
; szPatchPath : LPCSTR -> "sptr"
; dwReserved : DWORD optional -> "sptr"
; szXMLData : LPSTR optional, out -> "sptr"
; pcchXMLData : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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