ホーム › System.ApplicationInstallationAndServicing › MsiGetPatchInfoA

MsiGetPatchInfoA

関数

適用済みパッチの情報を取得する(ANSI版)。

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

シグネチャ

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

DWORD MsiGetPatchInfoA(
    LPCSTR szPatch,
    LPCSTR szAttribute,
    LPSTR lpValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前

型

方向

説明

szPatch

LPCSTR

パッチパッケージのパッチコードを指定します。

szAttribute

LPCSTR

取得する属性を指定します。

属性	意味
INSTALLPROPERTY_LOCALPACKAGE	ローカルにキャッシュされたパッケージ。

lpValueBuf

LPSTR

outoptional

プロパティ値を受け取るバッファーへのポインター。このパラメーターは null でもかまいません。

pcchValueBuf

DWORD*

inoutoptional

lpValueBuf パラメーターが指すバッファーのサイズ(文字数単位)を指定する変数へのポインター。入力時には、終端の null 文字分を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。

lpValueBuf が null の場合、pcchValueBuf も null にできます。

戻り値の型: DWORD

公式ドキュメント

MsiGetPatchInfo 関数は、パッチに関する情報を返します。(ANSI)

戻り値

MsiGetPatchInfo 関数は、次の値を返します。

値	意味
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_MORE_DATA	バッファーが小さすぎて、要求されたデータを保持できません。
ERROR_SUCCESS	関数は正常に完了しました。
ERROR_UNKNOWN_PRODUCT	パッチパッケージがインストールされていません。
ERROR_UNKNOWN_PROPERTY	プロパティが認識されません。

解説(Remarks)

MsiGetPatchInfo 関数が戻るとき、pcchValueBuf パラメーターには、バッファーに格納されたクラス文字列の長さが含まれます。返される文字数には、終端の null 文字は含まれません。

バッファーが小さすぎて要求されたデータを保持できない場合、MsiGetPatchInfo は ERROR_MORE_DATA を返し、pcchValueBuf には lpValueBuf にコピーされた文字数(null 文字は含まない)が格納されます。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiGetPatchInfo を定義します。エンコードに依存しないエイリアスの使用を、エンコードに依存しないわけではないコードと混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致が発生する可能性があります。詳細については、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 MsiGetPatchInfoA(
    LPCSTR szPatch,
    LPCSTR szAttribute,
    LPSTR lpValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiGetPatchInfoA(
    [MarshalAs(UnmanagedType.LPStr)] string szPatch,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szAttribute,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpValueBuf,   // LPSTR optional, out
    IntPtr pcchValueBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetPatchInfoA(
    <MarshalAs(UnmanagedType.LPStr)> szPatch As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szAttribute As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpValueBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

MsiGetPatchInfoA = ctypes.windll.msi.MsiGetPatchInfoA
MsiGetPatchInfoA.restype = wintypes.DWORD
MsiGetPatchInfoA.argtypes = [
    wintypes.LPCSTR,  # szPatch : LPCSTR
    wintypes.LPCSTR,  # szAttribute : LPCSTR
    wintypes.LPSTR,  # lpValueBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetPatchInfoA = Fiddle::Function.new(
  lib['MsiGetPatchInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # szPatch : LPCSTR
    Fiddle::TYPE_VOIDP,  # szAttribute : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpValueBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchValueBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetPatchInfoA(
        szPatch: *const u8,  // LPCSTR
        szAttribute: *const u8,  // LPCSTR
        lpValueBuf: *mut u8,  // LPSTR optional, out
        pcchValueBuf: *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 MsiGetPatchInfoA([MarshalAs(UnmanagedType.LPStr)] string szPatch, [MarshalAs(UnmanagedType.LPStr)] string szAttribute, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetPatchInfoA' -Namespace Win32 -PassThru
# $api::MsiGetPatchInfoA(szPatch, szAttribute, lpValueBuf, pcchValueBuf)

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

出力引数:

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