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

MsiSetPropertyA

関数
実行中のインストールセッションのプロパティ値を設定する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiSetPropertyA(
    MSIHANDLE hInstall,
    LPCSTR szName,
    LPCSTR szValue
);

パラメーター

名前方向説明
hInstallMSIHANDLEinDLL カスタムアクションに提供された、または MsiOpenPackageMsiOpenPackageExMsiOpenProduct によって取得されたインストールのハンドルです。
szNameLPCSTRinプロパティの名前を指定します。
szValueLPCSTRinプロパティの値を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiSetProperty 関数は、インストールプロパティの値を設定します。(ANSI)

戻り値

この関数は UINT を返します。

解説(Remarks)

プロパティが定義されていない場合は、 MsiSetProperty 関数によって作成されます。値が null または空の文字列の場合、プロパティは削除されます。

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiSetProperty を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、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 MsiSetPropertyA(
    MSIHANDLE hInstall,
    LPCSTR szName,
    LPCSTR szValue
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiSetPropertyA(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szValue   // LPCSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiSetPropertyA(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szValue As String   ' LPCSTR
) As UInteger
End Function
' hInstall : MSIHANDLE
' szName : LPCSTR
' szValue : LPCSTR
Declare PtrSafe Function MsiSetPropertyA Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szName As String, _
    ByVal szValue As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiSetPropertyA = ctypes.windll.msi.MsiSetPropertyA
MsiSetPropertyA.restype = wintypes.DWORD
MsiSetPropertyA.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCSTR,  # szName : LPCSTR
    wintypes.LPCSTR,  # szValue : LPCSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSetPropertyA = Fiddle::Function.new(
  lib['MsiSetPropertyA'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szValue : LPCSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiSetPropertyA(
        hInstall: u32,  // MSIHANDLE
        szName: *const u8,  // LPCSTR
        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 MsiSetPropertyA(uint hInstall, [MarshalAs(UnmanagedType.LPStr)] string szName, [MarshalAs(UnmanagedType.LPStr)] string szValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetPropertyA' -Namespace Win32 -PassThru
# $api::MsiSetPropertyA(hInstall, szName, szValue)
#uselib "msi.dll"
#func global MsiSetPropertyA "MsiSetPropertyA" sptr, sptr, sptr
; MsiSetPropertyA hInstall, szName, szValue   ; 戻り値は stat
; hInstall : MSIHANDLE -> "sptr"
; szName : LPCSTR -> "sptr"
; szValue : LPCSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSetPropertyA "MsiSetPropertyA" int, str, str
; res = MsiSetPropertyA(hInstall, szName, szValue)
; hInstall : MSIHANDLE -> "int"
; szName : LPCSTR -> "str"
; szValue : LPCSTR -> "str"
; DWORD MsiSetPropertyA(MSIHANDLE hInstall, LPCSTR szName, LPCSTR szValue)
#uselib "msi.dll"
#cfunc global MsiSetPropertyA "MsiSetPropertyA" int, str, str
; res = MsiSetPropertyA(hInstall, szName, szValue)
; hInstall : MSIHANDLE -> "int"
; szName : LPCSTR -> "str"
; szValue : LPCSTR -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSetPropertyA = msi.NewProc("MsiSetPropertyA")
)

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

extern "msi" fn MsiSetPropertyA(
    hInstall: u32, // MSIHANDLE
    szName: [*c]const u8, // LPCSTR
    szValue: [*c]const u8 // LPCSTR
) callconv(std.os.windows.WINAPI) u32;
proc MsiSetPropertyA(
    hInstall: uint32,  # MSIHANDLE
    szName: cstring,  # LPCSTR
    szValue: cstring  # LPCSTR
): uint32 {.importc: "MsiSetPropertyA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiSetPropertyA(
    uint hInstall,   // MSIHANDLE
    const(char)* szName,   // LPCSTR
    const(char)* szValue   // LPCSTR
);
ccall((:MsiSetPropertyA, "msi.dll"), stdcall, UInt32,
      (UInt32, Cstring, Cstring),
      hInstall, szName, szValue)
# hInstall : MSIHANDLE -> UInt32
# szName : LPCSTR -> Cstring
# szValue : LPCSTR -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSetPropertyA(
    uint32_t hInstall,
    const char* szName,
    const char* szValue);
]]
local msi = ffi.load("msi")
-- msi.MsiSetPropertyA(hInstall, szName, szValue)
-- hInstall : MSIHANDLE
-- szName : LPCSTR
-- szValue : LPCSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSetPropertyA = lib.func('__stdcall', 'MsiSetPropertyA', 'uint32_t', ['uint32_t', 'str', 'str']);
// MsiSetPropertyA(hInstall, szName, szValue)
// hInstall : MSIHANDLE -> 'uint32_t'
// szName : LPCSTR -> 'str'
// szValue : LPCSTR -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiSetPropertyA: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiSetPropertyA(hInstall, szName, szValue)
// hInstall : MSIHANDLE -> "u32"
// szName : LPCSTR -> "buffer"
// szValue : LPCSTR -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSetPropertyA(
    uint32_t hInstall,
    const char* szName,
    const char* szValue);
C, "msi.dll");
// $ffi->MsiSetPropertyA(hInstall, szName, szValue);
// hInstall : MSIHANDLE
// szName : LPCSTR
// szValue : LPCSTR
// 構造体/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 MsiSetPropertyA(
        int hInstall,   // MSIHANDLE
        String szName,   // LPCSTR
        String szValue   // LPCSTR
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiSetPropertyA = MsiSetPropertyA(
    hInstall : UInt32,   # MSIHANDLE
    szName : UInt8*,   # LPCSTR
    szValue : UInt8*   # LPCSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSetPropertyANative = Uint32 Function(Uint32, Pointer<Utf8>, Pointer<Utf8>);
typedef MsiSetPropertyADart = int Function(int, Pointer<Utf8>, Pointer<Utf8>);
final MsiSetPropertyA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSetPropertyANative, MsiSetPropertyADart>('MsiSetPropertyA');
// hInstall : MSIHANDLE -> Uint32
// szName : LPCSTR -> Pointer<Utf8>
// szValue : LPCSTR -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSetPropertyA(
  hInstall: DWORD;   // MSIHANDLE
  szName: PAnsiChar;   // LPCSTR
  szValue: PAnsiChar   // LPCSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSetPropertyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiSetPropertyA"
  c_MsiSetPropertyA :: Word32 -> CString -> CString -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szName : LPCSTR -> CString
-- szValue : LPCSTR -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msisetpropertya =
  foreign "MsiSetPropertyA"
    (uint32_t @-> string @-> string @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szName : LPCSTR -> string *)
(* szValue : LPCSTR -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiSetPropertyA" msi-set-property-a :convention :stdcall) :uint32
  (h-install :uint32)   ; MSIHANDLE
  (sz-name :string)   ; LPCSTR
  (sz-value :string))   ; LPCSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSetPropertyA = Win32::API::More->new('msi',
    'DWORD MsiSetPropertyA(DWORD hInstall, LPCSTR szName, LPCSTR szValue)');
# my $ret = $MsiSetPropertyA->Call($hInstall, $szName, $szValue);
# hInstall : MSIHANDLE -> DWORD
# szName : LPCSTR -> LPCSTR
# szValue : LPCSTR -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い