ホーム › System.ApplicationInstallationAndServicing › MsiExtractPatchXMLDataW

MsiExtractPatchXMLDataW

関数

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

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

シグネチャ

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

DWORD MsiExtractPatchXMLDataW(
    LPCWSTR szPatchPath,
    DWORD dwReserved,   // optional
    LPWSTR szXMLData,   // optional
    DWORD* pcchXMLData   // optional
);

パラメーター

名前	型	方向	説明
szPatchPath	LPCWSTR	in	照会対象となるパッチへのフルパス。null で終わる文字列として渡します。このパラメーターを NULL にすることはできません。
dwReserved	DWORD	optional	予約された引数で、0(ゼロ)を指定する必要があります。
szXMLData	LPWSTR	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 関数は、パッチがターゲットシステムに適用されるかどうかを判定するために使用できる情報を、そのパッチから抽出します。(Unicode)

戻り値

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

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

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiExtractPatchXMLDataW(
    [MarshalAs(UnmanagedType.LPWStr)] string szPatchPath,   // LPCWSTR
    uint dwReserved,   // DWORD optional
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szXMLData,   // LPWSTR optional, out
    IntPtr pcchXMLData   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiExtractPatchXMLDataW(
    <MarshalAs(UnmanagedType.LPWStr)> szPatchPath As String,   ' LPCWSTR
    dwReserved As UInteger,   ' DWORD optional
    <MarshalAs(UnmanagedType.LPWStr)> szXMLData As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchXMLData As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szPatchPath : LPCWSTR
' dwReserved : DWORD optional
' szXMLData : LPWSTR optional, out
' pcchXMLData : DWORD* optional, in/out
Declare PtrSafe Function MsiExtractPatchXMLDataW Lib "msi" ( _
    ByVal szPatchPath As LongPtr, _
    ByVal dwReserved As Long, _
    ByVal szXMLData As LongPtr, _
    ByVal pcchXMLData 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiExtractPatchXMLDataW = Fiddle::Function.new(
  lib['MsiExtractPatchXMLDataW'],
  [
    Fiddle::TYPE_VOIDP,  # szPatchPath : LPCWSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
    Fiddle::TYPE_VOIDP,  # szXMLData : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchXMLData : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiExtractPatchXMLDataW(
        szPatchPath: *const u16,  // LPCWSTR
        dwReserved: u32,  // DWORD optional
        szXMLData: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint MsiExtractPatchXMLDataW([MarshalAs(UnmanagedType.LPWStr)] string szPatchPath, uint dwReserved, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szXMLData, IntPtr pcchXMLData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiExtractPatchXMLDataW' -Namespace Win32 -PassThru
# $api::MsiExtractPatchXMLDataW(szPatchPath, dwReserved, szXMLData, pcchXMLData)

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

出力引数:

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