ホーム › Devices.DeviceAndDriverInstallation › SetupGetStringFieldW

SetupGetStringFieldW

関数

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

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

シグネチャ

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

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

パラメーター

名前	型	方向
Context	INFCONTEXT*	in
FieldIndex	DWORD	in
ReturnBuffer	LPWSTR	outoptional
ReturnBufferSize	DWORD	in
RequiredSize	DWORD*	outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupGetStringFieldW(
    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 SetupGetStringFieldW(
    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 SetupGetStringFieldW(
    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 Boolean
End Function

' Context : INFCONTEXT*
' FieldIndex : DWORD
' ReturnBuffer : LPWSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetStringFieldW 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

SetupGetStringFieldW = ctypes.windll.setupapi.SetupGetStringFieldW
SetupGetStringFieldW.restype = wintypes.BOOL
SetupGetStringFieldW.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')
SetupGetStringFieldW = Fiddle::Function.new(
  lib['SetupGetStringFieldW'],
  [
    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 SetupGetStringFieldW(
        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 SetupGetStringFieldW(IntPtr Context, uint FieldIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetStringFieldW' -Namespace Win32 -PassThru
# $api::SetupGetStringFieldW(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupGetStringFieldW "SetupGetStringFieldW" wptr, wptr, wptr, wptr, wptr
; SetupGetStringFieldW 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 SetupGetStringFieldW "SetupGetStringFieldW" var, int, var, int, var
; res = SetupGetStringFieldW(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 SetupGetStringFieldW "SetupGetStringFieldW" sptr, int, sptr, int, sptr
; res = SetupGetStringFieldW(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(変数))。

出力引数:

; BOOL SetupGetStringFieldW(INFCONTEXT* Context, DWORD FieldIndex, LPWSTR ReturnBuffer, DWORD ReturnBufferSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetStringFieldW "SetupGetStringFieldW" var, int, var, int, var
; res = SetupGetStringFieldW(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 方式にも切替可。; BOOL SetupGetStringFieldW(INFCONTEXT* Context, DWORD FieldIndex, LPWSTR ReturnBuffer, DWORD ReturnBufferSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetStringFieldW "SetupGetStringFieldW" intptr, int, intptr, int, intptr
; res = SetupGetStringFieldW(varptr(Context), FieldIndex, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize))
; Context : INFCONTEXT* -> "intptr"
; FieldIndex : DWORD -> "int"
; ReturnBuffer : LPWSTR optional, out -> "intptr"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupGetStringFieldW = setupapi.NewProc("SetupGetStringFieldW")
)

// Context (INFCONTEXT*), FieldIndex (DWORD), ReturnBuffer (LPWSTR optional, out), ReturnBufferSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupGetStringFieldW.Call(
	uintptr(Context),
	uintptr(FieldIndex),
	uintptr(ReturnBuffer),
	uintptr(ReturnBufferSize),
	uintptr(RequiredSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function SetupGetStringFieldW(
  Context: Pointer;   // INFCONTEXT*
  FieldIndex: DWORD;   // DWORD
  ReturnBuffer: PWideChar;   // LPWSTR optional, out
  ReturnBufferSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupGetStringFieldW';

result := DllCall("SETUPAPI\SetupGetStringFieldW"
    , "Ptr", Context   ; INFCONTEXT*
    , "UInt", FieldIndex   ; DWORD
    , "Ptr", ReturnBuffer   ; LPWSTR optional, out
    , "UInt", ReturnBufferSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "Int")   ; return: BOOL

●SetupGetStringFieldW(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupGetStringFieldW(void*, dword, char*, dword, void*)")
# 呼び出し: SetupGetStringFieldW(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
# Context : INFCONTEXT* -> "void*"
# FieldIndex : DWORD -> "dword"
# ReturnBuffer : LPWSTR optional, out -> "char*"
# ReturnBufferSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。