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

MsiRecordSetStringW

関数
レコードの指定フィールドに文字列値を設定する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiRecordSetStringW(
    MSIHANDLE hRecord,
    DWORD iField,
    LPCWSTR szValue
);

パラメーター

名前方向説明
hRecordMSIHANDLEinレコードへのハンドル。
iFieldDWORDin設定するレコードのフィールドを指定します。
szValueLPCWSTRinフィールドの文字列値を指定します。

戻り値の型: DWORD

公式ドキュメント

MsiRecordSetString 関数は、指定されたフィールドに文字列をコピーします。(Unicode)

戻り値

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

解説(Remarks)

MsiRecordSetString 関数では、null 文字列ポインターと空文字列のいずれもフィールドを null に設定します。存在しないフィールドに値を格納しようとするとエラーが発生します。

レコードの文字列フィールドを null に設定するには、szValue に null 文字列または空文字列を設定します。

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI バージョンまたは Unicode バージョンを自動的に選択するエイリアスとして MsiRecordSetString を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在して使用すると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiRecordSetStringW(
    MSIHANDLE hRecord,
    DWORD iField,
    LPCWSTR szValue
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiRecordSetStringW(
    uint hRecord,   // MSIHANDLE
    uint iField,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string szValue   // LPCWSTR
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiRecordSetStringW(
    hRecord As UInteger,   ' MSIHANDLE
    iField As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szValue As String   ' LPCWSTR
) As UInteger
End Function
' hRecord : MSIHANDLE
' iField : DWORD
' szValue : LPCWSTR
Declare PtrSafe Function MsiRecordSetStringW Lib "msi" ( _
    ByVal hRecord As Long, _
    ByVal iField As Long, _
    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

MsiRecordSetStringW = ctypes.windll.msi.MsiRecordSetStringW
MsiRecordSetStringW.restype = wintypes.DWORD
MsiRecordSetStringW.argtypes = [
    wintypes.DWORD,  # hRecord : MSIHANDLE
    wintypes.DWORD,  # iField : DWORD
    wintypes.LPCWSTR,  # szValue : LPCWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiRecordSetStringW = Fiddle::Function.new(
  lib['MsiRecordSetStringW'],
  [
    -Fiddle::TYPE_INT,  # hRecord : MSIHANDLE
    -Fiddle::TYPE_INT,  # iField : DWORD
    Fiddle::TYPE_VOIDP,  # szValue : LPCWSTR
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiRecordSetStringW(
        hRecord: u32,  // MSIHANDLE
        iField: u32,  // DWORD
        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 MsiRecordSetStringW(uint hRecord, uint iField, [MarshalAs(UnmanagedType.LPWStr)] string szValue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiRecordSetStringW' -Namespace Win32 -PassThru
# $api::MsiRecordSetStringW(hRecord, iField, szValue)
#uselib "msi.dll"
#func global MsiRecordSetStringW "MsiRecordSetStringW" wptr, wptr, wptr
; MsiRecordSetStringW hRecord, iField, szValue   ; 戻り値は stat
; hRecord : MSIHANDLE -> "wptr"
; iField : DWORD -> "wptr"
; szValue : LPCWSTR -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiRecordSetStringW "MsiRecordSetStringW" int, int, wstr
; res = MsiRecordSetStringW(hRecord, iField, szValue)
; hRecord : MSIHANDLE -> "int"
; iField : DWORD -> "int"
; szValue : LPCWSTR -> "wstr"
; DWORD MsiRecordSetStringW(MSIHANDLE hRecord, DWORD iField, LPCWSTR szValue)
#uselib "msi.dll"
#cfunc global MsiRecordSetStringW "MsiRecordSetStringW" int, int, wstr
; res = MsiRecordSetStringW(hRecord, iField, szValue)
; hRecord : MSIHANDLE -> "int"
; iField : DWORD -> "int"
; szValue : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiRecordSetStringW = msi.NewProc("MsiRecordSetStringW")
)

// hRecord (MSIHANDLE), iField (DWORD), szValue (LPCWSTR)
r1, _, err := procMsiRecordSetStringW.Call(
	uintptr(hRecord),
	uintptr(iField),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szValue))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiRecordSetStringW(
  hRecord: DWORD;   // MSIHANDLE
  iField: DWORD;   // DWORD
  szValue: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiRecordSetStringW';
result := DllCall("msi\MsiRecordSetStringW"
    , "UInt", hRecord   ; MSIHANDLE
    , "UInt", iField   ; DWORD
    , "WStr", szValue   ; LPCWSTR
    , "UInt")   ; return: DWORD
●MsiRecordSetStringW(hRecord, iField, szValue) = DLL("msi.dll", "dword MsiRecordSetStringW(dword, dword, char*)")
# 呼び出し: MsiRecordSetStringW(hRecord, iField, szValue)
# hRecord : MSIHANDLE -> "dword"
# iField : DWORD -> "dword"
# szValue : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiRecordSetStringW(
    hRecord: u32, // MSIHANDLE
    iField: u32, // DWORD
    szValue: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiRecordSetStringW(
    hRecord: uint32,  # MSIHANDLE
    iField: uint32,  # DWORD
    szValue: WideCString  # LPCWSTR
): uint32 {.importc: "MsiRecordSetStringW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiRecordSetStringW(
    uint hRecord,   // MSIHANDLE
    uint iField,   // DWORD
    const(wchar)* szValue   // LPCWSTR
);
ccall((:MsiRecordSetStringW, "msi.dll"), stdcall, UInt32,
      (UInt32, UInt32, Cwstring),
      hRecord, iField, szValue)
# hRecord : MSIHANDLE -> UInt32
# iField : DWORD -> UInt32
# szValue : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiRecordSetStringW(
    uint32_t hRecord,
    uint32_t iField,
    const uint16_t* szValue);
]]
local msi = ffi.load("msi")
-- msi.MsiRecordSetStringW(hRecord, iField, szValue)
-- hRecord : MSIHANDLE
-- iField : DWORD
-- 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 MsiRecordSetStringW = lib.func('__stdcall', 'MsiRecordSetStringW', 'uint32_t', ['uint32_t', 'uint32_t', 'str16']);
// MsiRecordSetStringW(hRecord, iField, szValue)
// hRecord : MSIHANDLE -> 'uint32_t'
// iField : DWORD -> 'uint32_t'
// szValue : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiRecordSetStringW: { parameters: ["u32", "u32", "buffer"], result: "u32" },
});
// lib.symbols.MsiRecordSetStringW(hRecord, iField, szValue)
// hRecord : MSIHANDLE -> "u32"
// iField : DWORD -> "u32"
// szValue : LPCWSTR -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiRecordSetStringW(
    uint32_t hRecord,
    uint32_t iField,
    const uint16_t* szValue);
C, "msi.dll");
// $ffi->MsiRecordSetStringW(hRecord, iField, szValue);
// hRecord : MSIHANDLE
// iField : DWORD
// 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 MsiRecordSetStringW(
        int hRecord,   // MSIHANDLE
        int iField,   // DWORD
        WString szValue   // LPCWSTR
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiRecordSetStringW = MsiRecordSetStringW(
    hRecord : UInt32,   # MSIHANDLE
    iField : UInt32,   # DWORD
    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 MsiRecordSetStringWNative = Uint32 Function(Uint32, Uint32, Pointer<Utf16>);
typedef MsiRecordSetStringWDart = int Function(int, int, Pointer<Utf16>);
final MsiRecordSetStringW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiRecordSetStringWNative, MsiRecordSetStringWDart>('MsiRecordSetStringW');
// hRecord : MSIHANDLE -> Uint32
// iField : DWORD -> Uint32
// szValue : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiRecordSetStringW(
  hRecord: DWORD;   // MSIHANDLE
  iField: DWORD;   // DWORD
  szValue: PWideChar   // LPCWSTR
): DWORD; stdcall;
  external 'msi.dll' name 'MsiRecordSetStringW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiRecordSetStringW"
  c_MsiRecordSetStringW :: Word32 -> Word32 -> CWString -> IO Word32
-- hRecord : MSIHANDLE -> Word32
-- iField : DWORD -> Word32
-- szValue : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msirecordsetstringw =
  foreign "MsiRecordSetStringW"
    (uint32_t @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* hRecord : MSIHANDLE -> uint32_t *)
(* iField : DWORD -> uint32_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 ("MsiRecordSetStringW" msi-record-set-string-w :convention :stdcall) :uint32
  (h-record :uint32)   ; MSIHANDLE
  (i-field :uint32)   ; DWORD
  (sz-value (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiRecordSetStringW = Win32::API::More->new('msi',
    'DWORD MsiRecordSetStringW(DWORD hRecord, DWORD iField, LPCWSTR szValue)');
# my $ret = $MsiRecordSetStringW->Call($hRecord, $iField, $szValue);
# hRecord : MSIHANDLE -> DWORD
# iField : DWORD -> DWORD
# szValue : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い