ホーム › System.ApplicationInstallationAndServicing › MsiRecordGetStringA

MsiRecordGetStringA

関数

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

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

シグネチャ

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

DWORD MsiRecordGetStringA(
    MSIHANDLE hRecord,
    DWORD iField,
    LPSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前	型	方向	説明
hRecord	MSIHANDLE	in	レコードへのハンドル。
iField	DWORD	in	要求するフィールドを指定します。
szValueBuf	LPSTR	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 関数は、レコードフィールドの文字列値を返します。(ANSI)

戻り値

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

解説(Remarks)

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

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiRecordGetString を定義しています。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、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 MsiRecordGetStringA(
    MSIHANDLE hRecord,
    DWORD iField,
    LPSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

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

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

' hRecord : MSIHANDLE
' iField : DWORD
' szValueBuf : LPSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiRecordGetStringA Lib "msi" ( _
    ByVal hRecord As Long, _
    ByVal iField As Long, _
    ByVal szValueBuf As String, _
    ByVal pcchValueBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiRecordGetStringA = Fiddle::Function.new(
  lib['MsiRecordGetStringA'],
  [
    -Fiddle::TYPE_INT,  # hRecord : MSIHANDLE
    -Fiddle::TYPE_INT,  # iField : DWORD
    Fiddle::TYPE_VOIDP,  # szValueBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchValueBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

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

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

出力引数:

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