ホーム › Devices.DeviceAndDriverInstallation › SetupGetMultiSzFieldW

SetupGetMultiSzFieldW

関数

INF行の指定フィールド以降の複数文字列を取得する(Unicode)。

DLLSETUPAPI.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL SetupGetMultiSzFieldW(
    INFCONTEXT* Context,
    DWORD FieldIndex,
    LPWSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
Context	INFCONTEXT*	in	INF ファイル内の行のコンテキストへのポインター。
FieldIndex	DWORD	in	文字列の取得を開始する、指定した行内のフィールドの 1 から始まるインデックス。文字列リストは、この位置から行末までの各フィールドから構築されます。この関数では、FieldIndex に 0 を指定することはできません。
ReturnBuffer	LPWSTR	outoptional	文字列を受け取る文字バッファーへのポインター (省略可能)。各文字列は null で終端され、文字列リストの末尾にはさらに null が付加されます。null 終端の文字列は、コピー先バッファーのサイズを超えてはなりません。まず関数を 1 回呼び出して必要なバッファーサイズを取得し、必要なメモリを割り当ててから、2 回目の呼び出しでデータを取得できます。この方法を使用すると、バッファーサイズの不足によるエラーを回避できます。「解説」セクションを参照してください。このパラメーターには NULL を指定できます。
ReturnBufferSize	DWORD	in	ReturnBuffer が指すバッファーのサイズ (文字数単位)。これには null 終端文字が含まれます。
RequiredSize	DWORD*	outoptional	ReturnBuffer が指すバッファーに必要なサイズ (文字数単位) を受け取る変数へのポインター (省略可能)。これには null 終端文字が含まれます。必要なサイズが ReturnBufferSize で指定された値より大きい場合、関数は失敗し、GetLastError の呼び出しは ERROR_INSUFFICIENT_BUFFER を返します。

戻り値の型: BOOL

公式ドキュメント

SetupGetMultiSzField 関数は、INF ファイルの行に格納されている複数の文字列を、指定されたフィールドから行末までの範囲で取得します。(Unicode)

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

ReturnBuffer に NULL、ReturnBufferSize に 0 を指定してこの関数を呼び出すと、指定したデータを格納するために必要なバッファーサイズが RequiredSize が指す変数に格納されます。これに成功した場合、戻り値は 0 以外の値です。それ以外の場合、戻り値は 0 であり、拡張エラー情報は GetLastError を呼び出すことで取得できます。

SetupGetMultiSzField は、INF 行の文字列値を反復処理する目的で使用しないでください。代わりに SetupGetStringField を使用してください。SetupGetMultiSzField は REG_MULTI_SZ 形式の値を返します。これは、null 終端された文字列の配列であり、末尾にさらに null 文字が付加されたものです。この形式では長さ 0 の文字列を扱えません。文字列のリストに長さ 0 の文字列が含まれている場合、SetupGetMultiSzField は最初の空の文字列値に到達した時点で処理を打ち切って戻ります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL SetupGetMultiSzFieldW(
    INFCONTEXT* Context,
    DWORD FieldIndex,
    LPWSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetMultiSzFieldW(
    IntPtr Context,   // INFCONTEXT*
    uint FieldIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer,   // LPWSTR optional, out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetMultiSzFieldW(
    Context As IntPtr,   ' INFCONTEXT*
    FieldIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> ReturnBuffer As System.Text.StringBuilder,   ' LPWSTR optional, out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' Context : INFCONTEXT*
' FieldIndex : DWORD
' ReturnBuffer : LPWSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetMultiSzFieldW Lib "setupapi" ( _
    ByVal Context As LongPtr, _
    ByVal FieldIndex As Long, _
    ByVal ReturnBuffer As LongPtr, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize 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

SetupGetMultiSzFieldW = ctypes.windll.setupapi.SetupGetMultiSzFieldW
SetupGetMultiSzFieldW.restype = wintypes.BOOL
SetupGetMultiSzFieldW.argtypes = [
    ctypes.c_void_p,  # Context : INFCONTEXT*
    wintypes.DWORD,  # FieldIndex : DWORD
    wintypes.LPWSTR,  # ReturnBuffer : LPWSTR optional, out
    wintypes.DWORD,  # ReturnBufferSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupGetMultiSzFieldW = Fiddle::Function.new(
  lib['SetupGetMultiSzFieldW'],
  [
    Fiddle::TYPE_VOIDP,  # Context : INFCONTEXT*
    -Fiddle::TYPE_INT,  # FieldIndex : DWORD
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPWSTR optional, out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "setupapi")]
extern "system" {
    fn SetupGetMultiSzFieldW(
        Context: *mut INFCONTEXT,  // INFCONTEXT*
        FieldIndex: u32,  // DWORD
        ReturnBuffer: *mut u16,  // LPWSTR optional, out
        ReturnBufferSize: u32,  // DWORD
        RequiredSize: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetupGetMultiSzFieldW(IntPtr Context, uint FieldIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetMultiSzFieldW' -Namespace Win32 -PassThru
# $api::SetupGetMultiSzFieldW(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupGetMultiSzFieldW "SetupGetMultiSzFieldW" wptr, wptr, wptr, wptr, wptr
; SetupGetMultiSzFieldW varptr(Context), FieldIndex, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; Context : INFCONTEXT* -> "wptr"
; FieldIndex : DWORD -> "wptr"
; ReturnBuffer : LPWSTR optional, out -> "wptr"
; ReturnBufferSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupGetMultiSzFieldW "SetupGetMultiSzFieldW" var, int, var, int, var
; res = SetupGetMultiSzFieldW(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
; Context : INFCONTEXT* -> "var"
; FieldIndex : DWORD -> "int"
; ReturnBuffer : LPWSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupGetMultiSzFieldW "SetupGetMultiSzFieldW" sptr, int, sptr, int, sptr
; res = SetupGetMultiSzFieldW(varptr(Context), FieldIndex, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize))
; Context : INFCONTEXT* -> "sptr"
; FieldIndex : DWORD -> "int"
; ReturnBuffer : LPWSTR optional, out -> "sptr"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。