ホーム › System.ApplicationInstallationAndServicing › MsiSetPropertyW
MsiSetPropertyW
関数実行中のインストールセッションのプロパティ値を設定する。
シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiSetPropertyW(
MSIHANDLE hInstall,
LPCWSTR szName,
LPCWSTR szValue
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hInstall | MSIHANDLE | in | DLL カスタム アクションに提供された、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct を通じて取得した、インストールへのハンドルです。 |
| szName | LPCWSTR | in | プロパティの名前を指定します。 |
| szValue | LPCWSTR | in | プロパティの値を指定します。 |
戻り値の型: DWORD
公式ドキュメント
MsiSetProperty 関数は、インストール プロパティの値を設定します。(Unicode)
戻り値
この関数は 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)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiSetPropertyW(
MSIHANDLE hInstall,
LPCWSTR szName,
LPCWSTR szValue
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSetPropertyW(
uint hInstall, // MSIHANDLE
[MarshalAs(UnmanagedType.LPWStr)] string szName, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string szValue // LPCWSTR
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSetPropertyW(
hInstall As UInteger, ' MSIHANDLE
<MarshalAs(UnmanagedType.LPWStr)> szName As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> szValue As String ' LPCWSTR
) As UInteger
End Function' hInstall : MSIHANDLE
' szName : LPCWSTR
' szValue : LPCWSTR
Declare PtrSafe Function MsiSetPropertyW Lib "msi" ( _
ByVal hInstall As Long, _
ByVal szName As LongPtr, _
ByVal szValue 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
MsiSetPropertyW = ctypes.windll.msi.MsiSetPropertyW
MsiSetPropertyW.restype = wintypes.DWORD
MsiSetPropertyW.argtypes = [
wintypes.DWORD, # hInstall : MSIHANDLE
wintypes.LPCWSTR, # szName : LPCWSTR
wintypes.LPCWSTR, # szValue : LPCWSTR
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiSetPropertyW = Fiddle::Function.new(
lib['MsiSetPropertyW'],
[
-Fiddle::TYPE_INT, # hInstall : MSIHANDLE
Fiddle::TYPE_VOIDP, # szName : LPCWSTR
Fiddle::TYPE_VOIDP, # szValue : LPCWSTR
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiSetPropertyW(
hInstall: u32, // MSIHANDLE
szName: *const u16, // LPCWSTR
szValue: *const u16 // LPCWSTR
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSetPropertyW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szName, [MarshalAs(UnmanagedType.LPWStr)] string szValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSetPropertyW' -Namespace Win32 -PassThru
# $api::MsiSetPropertyW(hInstall, szName, szValue)#uselib "msi.dll"
#func global MsiSetPropertyW "MsiSetPropertyW" wptr, wptr, wptr
; MsiSetPropertyW hInstall, szName, szValue ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szName : LPCWSTR -> "wptr"
; szValue : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiSetPropertyW "MsiSetPropertyW" int, wstr, wstr
; res = MsiSetPropertyW(hInstall, szName, szValue)
; hInstall : MSIHANDLE -> "int"
; szName : LPCWSTR -> "wstr"
; szValue : LPCWSTR -> "wstr"; DWORD MsiSetPropertyW(MSIHANDLE hInstall, LPCWSTR szName, LPCWSTR szValue)
#uselib "msi.dll"
#cfunc global MsiSetPropertyW "MsiSetPropertyW" int, wstr, wstr
; res = MsiSetPropertyW(hInstall, szName, szValue)
; hInstall : MSIHANDLE -> "int"
; szName : LPCWSTR -> "wstr"
; szValue : LPCWSTR -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiSetPropertyW = msi.NewProc("MsiSetPropertyW")
)
// hInstall (MSIHANDLE), szName (LPCWSTR), szValue (LPCWSTR)
r1, _, err := procMsiSetPropertyW.Call(
uintptr(hInstall),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szName))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szValue))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiSetPropertyW(
hInstall: DWORD; // MSIHANDLE
szName: PWideChar; // LPCWSTR
szValue: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetPropertyW';result := DllCall("msi\MsiSetPropertyW"
, "UInt", hInstall ; MSIHANDLE
, "WStr", szName ; LPCWSTR
, "WStr", szValue ; LPCWSTR
, "UInt") ; return: DWORD●MsiSetPropertyW(hInstall, szName, szValue) = DLL("msi.dll", "dword MsiSetPropertyW(dword, char*, char*)")
# 呼び出し: MsiSetPropertyW(hInstall, szName, szValue)
# hInstall : MSIHANDLE -> "dword"
# szName : LPCWSTR -> "char*"
# szValue : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiSetPropertyW(
hInstall: u32, // MSIHANDLE
szName: [*c]const u16, // LPCWSTR
szValue: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiSetPropertyW(
hInstall: uint32, # MSIHANDLE
szName: WideCString, # LPCWSTR
szValue: WideCString # LPCWSTR
): uint32 {.importc: "MsiSetPropertyW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiSetPropertyW(
uint hInstall, // MSIHANDLE
const(wchar)* szName, // LPCWSTR
const(wchar)* szValue // LPCWSTR
);ccall((:MsiSetPropertyW, "msi.dll"), stdcall, UInt32,
(UInt32, Cwstring, Cwstring),
hInstall, szName, szValue)
# hInstall : MSIHANDLE -> UInt32
# szName : LPCWSTR -> Cwstring
# szValue : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSetPropertyW(
uint32_t hInstall,
const uint16_t* szName,
const uint16_t* szValue);
]]
local msi = ffi.load("msi")
-- msi.MsiSetPropertyW(hInstall, szName, szValue)
-- hInstall : MSIHANDLE
-- szName : LPCWSTR
-- szValue : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSetPropertyW = lib.func('__stdcall', 'MsiSetPropertyW', 'uint32_t', ['uint32_t', 'str16', 'str16']);
// MsiSetPropertyW(hInstall, szName, szValue)
// hInstall : MSIHANDLE -> 'uint32_t'
// szName : LPCWSTR -> 'str16'
// szValue : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiSetPropertyW: { parameters: ["u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiSetPropertyW(hInstall, szName, szValue)
// hInstall : MSIHANDLE -> "u32"
// szName : LPCWSTR -> "buffer"
// szValue : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSetPropertyW(
uint32_t hInstall,
const uint16_t* szName,
const uint16_t* szValue);
C, "msi.dll");
// $ffi->MsiSetPropertyW(hInstall, szName, szValue);
// hInstall : MSIHANDLE
// szName : LPCWSTR
// szValue : LPCWSTR
// 構造体/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.UNICODE_OPTIONS);
int MsiSetPropertyW(
int hInstall, // MSIHANDLE
WString szName, // LPCWSTR
WString szValue // LPCWSTR
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiSetPropertyW = MsiSetPropertyW(
hInstall : UInt32, # MSIHANDLE
szName : UInt16*, # LPCWSTR
szValue : UInt16* # LPCWSTR
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiSetPropertyWNative = Uint32 Function(Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef MsiSetPropertyWDart = int Function(int, Pointer<Utf16>, Pointer<Utf16>);
final MsiSetPropertyW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiSetPropertyWNative, MsiSetPropertyWDart>('MsiSetPropertyW');
// hInstall : MSIHANDLE -> Uint32
// szName : LPCWSTR -> Pointer<Utf16>
// szValue : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiSetPropertyW(
hInstall: DWORD; // MSIHANDLE
szName: PWideChar; // LPCWSTR
szValue: PWideChar // LPCWSTR
): DWORD; stdcall;
external 'msi.dll' name 'MsiSetPropertyW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiSetPropertyW"
c_MsiSetPropertyW :: Word32 -> CWString -> CWString -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- szName : LPCWSTR -> CWString
-- szValue : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msisetpropertyw =
foreign "MsiSetPropertyW"
(uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* szName : LPCWSTR -> (ptr uint16_t) *)
(* szValue : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiSetPropertyW" msi-set-property-w :convention :stdcall) :uint32
(h-install :uint32) ; MSIHANDLE
(sz-name (:string :encoding :utf-16le)) ; LPCWSTR
(sz-value (:string :encoding :utf-16le))) ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiSetPropertyW = Win32::API::More->new('msi',
'DWORD MsiSetPropertyW(DWORD hInstall, LPCWSTR szName, LPCWSTR szValue)');
# my $ret = $MsiSetPropertyW->Call($hInstall, $szName, $szValue);
# hInstall : MSIHANDLE -> DWORD
# szName : LPCWSTR -> LPCWSTR
# szValue : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f MsiSetPropertyA (ANSI版) — 実行中のインストールセッションのプロパティ値を設定する。