ホーム › System.ApplicationInstallationAndServicing › MsiRecordGetStringW

MsiRecordGetStringW

関数

レコードの指定フィールドから文字列値を取得する。

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

シグネチャ

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

DWORD MsiRecordGetStringW(
    MSIHANDLE hRecord,
    DWORD iField,
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前	型	方向	説明
hRecord	MSIHANDLE	in	レコードへのハンドル。
iField	DWORD	in	要求するフィールドを指定します。
szValueBuf	LPWSTR	outoptional	レコードフィールドの値を含む、null で終端された文字列を受け取るバッファーへのポインター。szValueBuf に null (value=0) を渡してバッファーのサイズを判定しようとしないでください。バッファーのサイズを取得するには、空文字列(例: "")を渡します。この場合、関数は ERROR_MORE_DATA を返し、pcchValueBuf には終端の null 文字を含まない、必要なバッファーサイズが TCHAR 単位で格納されます。ERROR_SUCCESS が返された場合、pcchValueBuf には終端の null 文字を含まない、バッファーに書き込まれた TCHAR の数が格納されます。
pcchValueBuf	DWORD*	inoutoptional	変数 szValueBuf が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。関数が ERROR_SUCCESS を返した場合、この変数には終端の null 文字を含まない、szValueBuf にコピーされたデータのサイズが格納されます。szValueBuf が十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、終端の null 文字を含まない必要なサイズを pcchValueBuf が指す変数に格納します。

戻り値の型: DWORD

公式ドキュメント

MsiRecordGetString 関数は、レコードフィールドの文字列値を返します。(Unicode)

戻り値

MsiRecordGetString 関数は、次のいずれかの値を返します:

解説(Remarks)

ERROR_MORE_DATA が返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを示します。ERROR_SUCCESS が返された場合は、文字列バッファーに書き込まれた文字数を示します。バッファーのサイズを取得するには、szValueBuf として 1 文字分のバッファーのアドレスを渡し、pcchValueBuf でバッファーのサイズを 0 と指定します。これにより、関数が返す文字列値がバッファーに収まらないことが保証されます。Null (value=0) を渡してバッファーのサイズを判定しようとしないでください。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiRecordGetStringW(
    MSIHANDLE hRecord,
    DWORD iField,
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiRecordGetStringW(
    uint hRecord,   // MSIHANDLE
    uint iField,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szValueBuf,   // LPWSTR optional, out
    IntPtr pcchValueBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiRecordGetStringW(
    hRecord As UInteger,   ' MSIHANDLE
    iField As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szValueBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hRecord : MSIHANDLE
' iField : DWORD
' szValueBuf : LPWSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiRecordGetStringW Lib "msi" ( _
    ByVal hRecord As Long, _
    ByVal iField As Long, _
    ByVal szValueBuf As LongPtr, _
    ByVal pcchValueBuf 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

MsiRecordGetStringW = ctypes.windll.msi.MsiRecordGetStringW
MsiRecordGetStringW.restype = wintypes.DWORD
MsiRecordGetStringW.argtypes = [
    wintypes.DWORD,  # hRecord : MSIHANDLE
    wintypes.DWORD,  # iField : DWORD
    wintypes.LPWSTR,  # szValueBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiRecordGetStringW = Fiddle::Function.new(
  lib['MsiRecordGetStringW'],
  [
    -Fiddle::TYPE_INT,  # hRecord : MSIHANDLE
    -Fiddle::TYPE_INT,  # iField : DWORD
    Fiddle::TYPE_VOIDP,  # szValueBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchValueBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiRecordGetStringW(
        hRecord: u32,  // MSIHANDLE
        iField: u32,  // DWORD
        szValueBuf: *mut u16,  // LPWSTR 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.Unicode)]
public static extern uint MsiRecordGetStringW(uint hRecord, uint iField, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiRecordGetStringW' -Namespace Win32 -PassThru
# $api::MsiRecordGetStringW(hRecord, iField, szValueBuf, pcchValueBuf)

#uselib "msi.dll"
#func global MsiRecordGetStringW "MsiRecordGetStringW" wptr, wptr, wptr, wptr
; MsiRecordGetStringW hRecord, iField, varptr(szValueBuf), varptr(pcchValueBuf)   ; 戻り値は stat
; hRecord : MSIHANDLE -> "wptr"
; iField : DWORD -> "wptr"
; szValueBuf : LPWSTR optional, out -> "wptr"
; pcchValueBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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