ホーム › System.ApplicationInstallationAndServicing › MsiSummaryInfoSetPropertyA

MsiSummaryInfoSetPropertyA

関数

サマリ情報の指定プロパティに値を設定する。

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

シグネチャ

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

DWORD MsiSummaryInfoSetPropertyA(
    MSIHANDLE hSummaryInfo,
    DWORD uiProperty,
    DWORD uiDataType,
    INT iValue,
    FILETIME* pftValue,
    LPCSTR szValue
);

パラメーター

名前	型	方向	説明
hSummaryInfo	MSIHANDLE	in	サマリー情報へのハンドル。
uiProperty	DWORD	in	設定するサマリープロパティのプロパティ ID を指定します。このパラメーターには、Summary Information Stream Property Set に列挙されているプロパティ ID を指定できます。この関数は、PID_DICTIONARY および PID_THUMBNAIL プロパティの値は設定しません。
uiDataType	DWORD	in	設定するプロパティの型を指定します。このパラメーターには、 Summary Information Stream Property Set に列挙されている型を指定できます。
iValue	INT	in	整数値を指定します。
pftValue	FILETIME*	inout	ファイル時刻値を指定します。
szValue	LPCSTR	in	テキスト値を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiSummaryInfoSetProperty 関数は、単一のサマリー情報プロパティを設定します。(ANSI)

戻り値

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

解説(Remarks)

メモ

msiquery.h ヘッダーは、MsiSummaryInfoSetProperty を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不整合が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 MsiSummaryInfoSetPropertyA(
    MSIHANDLE hSummaryInfo,
    DWORD uiProperty,
    DWORD uiDataType,
    INT iValue,
    FILETIME* pftValue,
    LPCSTR szValue
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiSummaryInfoSetPropertyA(
    uint hSummaryInfo,   // MSIHANDLE
    uint uiProperty,   // DWORD
    uint uiDataType,   // DWORD
    int iValue,   // INT
    IntPtr pftValue,   // FILETIME* in/out
    [MarshalAs(UnmanagedType.LPStr)] string szValue   // LPCSTR
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiSummaryInfoSetPropertyA(
    hSummaryInfo As UInteger,   ' MSIHANDLE
    uiProperty As UInteger,   ' DWORD
    uiDataType As UInteger,   ' DWORD
    iValue As Integer,   ' INT
    pftValue As IntPtr,   ' FILETIME* in/out
    <MarshalAs(UnmanagedType.LPStr)> szValue As String   ' LPCSTR
) As UInteger
End Function

' hSummaryInfo : MSIHANDLE
' uiProperty : DWORD
' uiDataType : DWORD
' iValue : INT
' pftValue : FILETIME* in/out
' szValue : LPCSTR
Declare PtrSafe Function MsiSummaryInfoSetPropertyA Lib "msi" ( _
    ByVal hSummaryInfo As Long, _
    ByVal uiProperty As Long, _
    ByVal uiDataType As Long, _
    ByVal iValue As Long, _
    ByVal pftValue As LongPtr, _
    ByVal szValue As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiSummaryInfoSetPropertyA = ctypes.windll.msi.MsiSummaryInfoSetPropertyA
MsiSummaryInfoSetPropertyA.restype = wintypes.DWORD
MsiSummaryInfoSetPropertyA.argtypes = [
    wintypes.DWORD,  # hSummaryInfo : MSIHANDLE
    wintypes.DWORD,  # uiProperty : DWORD
    wintypes.DWORD,  # uiDataType : DWORD
    ctypes.c_int,  # iValue : INT
    ctypes.c_void_p,  # pftValue : FILETIME* in/out
    wintypes.LPCSTR,  # szValue : LPCSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSummaryInfoSetPropertyA = Fiddle::Function.new(
  lib['MsiSummaryInfoSetPropertyA'],
  [
    -Fiddle::TYPE_INT,  # hSummaryInfo : MSIHANDLE
    -Fiddle::TYPE_INT,  # uiProperty : DWORD
    -Fiddle::TYPE_INT,  # uiDataType : DWORD
    Fiddle::TYPE_INT,  # iValue : INT
    Fiddle::TYPE_VOIDP,  # pftValue : FILETIME* in/out
    Fiddle::TYPE_VOIDP,  # szValue : LPCSTR
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiSummaryInfoSetPropertyA(
        hSummaryInfo: u32,  // MSIHANDLE
        uiProperty: u32,  // DWORD
        uiDataType: u32,  // DWORD
        iValue: i32,  // INT
        pftValue: *mut FILETIME,  // FILETIME* in/out
        szValue: *const u8  // LPCSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiSummaryInfoSetPropertyA(uint hSummaryInfo, uint uiProperty, uint uiDataType, int iValue, IntPtr pftValue, [MarshalAs(UnmanagedType.LPStr)] string szValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSummaryInfoSetPropertyA' -Namespace Win32 -PassThru
# $api::MsiSummaryInfoSetPropertyA(hSummaryInfo, uiProperty, uiDataType, iValue, pftValue, szValue)

#uselib "msi.dll"
#func global MsiSummaryInfoSetPropertyA "MsiSummaryInfoSetPropertyA" sptr, sptr, sptr, sptr, sptr, sptr
; MsiSummaryInfoSetPropertyA hSummaryInfo, uiProperty, uiDataType, iValue, varptr(pftValue), szValue   ; 戻り値は stat
; hSummaryInfo : MSIHANDLE -> "sptr"
; uiProperty : DWORD -> "sptr"
; uiDataType : DWORD -> "sptr"
; iValue : INT -> "sptr"
; pftValue : FILETIME* in/out -> "sptr"
; szValue : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiSummaryInfoSetPropertyA "MsiSummaryInfoSetPropertyA" int, int, int, int, var, str
; res = MsiSummaryInfoSetPropertyA(hSummaryInfo, uiProperty, uiDataType, iValue, pftValue, szValue)
; hSummaryInfo : MSIHANDLE -> "int"
; uiProperty : DWORD -> "int"
; uiDataType : DWORD -> "int"
; iValue : INT -> "int"
; pftValue : FILETIME* in/out -> "var"
; szValue : LPCSTR -> "str"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiSummaryInfoSetPropertyA "MsiSummaryInfoSetPropertyA" int, int, int, int, sptr, str
; res = MsiSummaryInfoSetPropertyA(hSummaryInfo, uiProperty, uiDataType, iValue, varptr(pftValue), szValue)
; hSummaryInfo : MSIHANDLE -> "int"
; uiProperty : DWORD -> "int"
; uiDataType : DWORD -> "int"
; iValue : INT -> "int"
; pftValue : FILETIME* in/out -> "sptr"
; szValue : LPCSTR -> "str"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。