Win32 API 日本語リファレンス
ホーム › Devices.DeviceAndDriverInstallation › SetupGetStringFieldA

SetupGetStringFieldA

関数
INF行の指定フィールドの文字列値を取得する(ANSI)。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

BOOL SetupGetStringFieldA(
    INFCONTEXT* Context,
    DWORD FieldIndex,
    LPSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前型方向説明
ContextINFCONTEXT*in対象行を示すINFCONTEXT構造体へのポインタ。
FieldIndexDWORDin取得するフィールドのインデックス。0はキー、1以降が各値となる。
ReturnBufferLPSTRoutoptionalフィールド値の文字列を受け取るバッファ(ANSI)。NULLでサイズ取得のみ可。
ReturnBufferSizeDWORDinReturnBufferのサイズ(文字数)。
RequiredSizeDWORD*outoptional必要なバッファサイズを受け取る出力ポインタ。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupGetStringFieldA(
    INFCONTEXT* Context,
    DWORD FieldIndex,
    LPSTR ReturnBuffer,   // optional
    DWORD ReturnBufferSize,
    DWORD* RequiredSize   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupGetStringFieldA(
    IntPtr Context,   // INFCONTEXT*
    uint FieldIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer,   // LPSTR optional, out
    uint ReturnBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupGetStringFieldA(
    Context As IntPtr,   ' INFCONTEXT*
    FieldIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> ReturnBuffer As System.Text.StringBuilder,   ' LPSTR optional, out
    ReturnBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' Context : INFCONTEXT*
' FieldIndex : DWORD
' ReturnBuffer : LPSTR optional, out
' ReturnBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupGetStringFieldA Lib "setupapi" ( _
    ByVal Context As LongPtr, _
    ByVal FieldIndex As Long, _
    ByVal ReturnBuffer As String, _
    ByVal ReturnBufferSize As Long, _
    ByVal RequiredSize As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetupGetStringFieldA = ctypes.windll.setupapi.SetupGetStringFieldA
SetupGetStringFieldA.restype = wintypes.BOOL
SetupGetStringFieldA.argtypes = [
    ctypes.c_void_p,  # Context : INFCONTEXT*
    wintypes.DWORD,  # FieldIndex : DWORD
    wintypes.LPSTR,  # ReturnBuffer : LPSTR 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')
SetupGetStringFieldA = Fiddle::Function.new(
  lib['SetupGetStringFieldA'],
  [
    Fiddle::TYPE_VOIDP,  # Context : INFCONTEXT*
    -Fiddle::TYPE_INT,  # FieldIndex : DWORD
    Fiddle::TYPE_VOIDP,  # ReturnBuffer : LPSTR optional, out
    -Fiddle::TYPE_INT,  # ReturnBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupGetStringFieldA(
        Context: *mut INFCONTEXT,  // INFCONTEXT*
        FieldIndex: u32,  // DWORD
        ReturnBuffer: *mut u8,  // LPSTR 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.Ansi, SetLastError = true)]
public static extern bool SetupGetStringFieldA(IntPtr Context, uint FieldIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder ReturnBuffer, uint ReturnBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupGetStringFieldA' -Namespace Win32 -PassThru
# $api::SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
#uselib "SETUPAPI.dll"
#func global SetupGetStringFieldA "SetupGetStringFieldA" sptr, sptr, sptr, sptr, sptr
; SetupGetStringFieldA varptr(Context), FieldIndex, varptr(ReturnBuffer), ReturnBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; Context : INFCONTEXT* -> "sptr"
; FieldIndex : DWORD -> "sptr"
; ReturnBuffer : LPSTR optional, out -> "sptr"
; ReturnBufferSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "SETUPAPI.dll"
#cfunc global SetupGetStringFieldA "SetupGetStringFieldA" var, int, var, int, var
; res = SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
; Context : INFCONTEXT* -> "var"
; FieldIndex : DWORD -> "int"
; ReturnBuffer : LPSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL SetupGetStringFieldA(INFCONTEXT* Context, DWORD FieldIndex, LPSTR ReturnBuffer, DWORD ReturnBufferSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupGetStringFieldA "SetupGetStringFieldA" var, int, var, int, var
; res = SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
; Context : INFCONTEXT* -> "var"
; FieldIndex : DWORD -> "int"
; ReturnBuffer : LPSTR optional, out -> "var"
; ReturnBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupGetStringFieldA = setupapi.NewProc("SetupGetStringFieldA")
)

// Context (INFCONTEXT*), FieldIndex (DWORD), ReturnBuffer (LPSTR optional, out), ReturnBufferSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupGetStringFieldA.Call(
	uintptr(Context),
	uintptr(FieldIndex),
	uintptr(ReturnBuffer),
	uintptr(ReturnBufferSize),
	uintptr(RequiredSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupGetStringFieldA(
  Context: Pointer;   // INFCONTEXT*
  FieldIndex: DWORD;   // DWORD
  ReturnBuffer: PAnsiChar;   // LPSTR optional, out
  ReturnBufferSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupGetStringFieldA';
result := DllCall("SETUPAPI\SetupGetStringFieldA"
    , "Ptr", Context   ; INFCONTEXT*
    , "UInt", FieldIndex   ; DWORD
    , "Ptr", ReturnBuffer   ; LPSTR optional, out
    , "UInt", ReturnBufferSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupGetStringFieldA(void*, dword, char*, dword, void*)")
# 呼び出し: SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
# Context : INFCONTEXT* -> "void*"
# FieldIndex : DWORD -> "dword"
# ReturnBuffer : LPSTR optional, out -> "char*"
# ReturnBufferSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "setupapi" fn SetupGetStringFieldA(
    Context: [*c]INFCONTEXT, // INFCONTEXT*
    FieldIndex: u32, // DWORD
    ReturnBuffer: [*c]u8, // LPSTR optional, out
    ReturnBufferSize: u32, // DWORD
    RequiredSize: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SetupGetStringFieldA(
    Context: ptr INFCONTEXT,  # INFCONTEXT*
    FieldIndex: uint32,  # DWORD
    ReturnBuffer: ptr char,  # LPSTR optional, out
    ReturnBufferSize: uint32,  # DWORD
    RequiredSize: ptr uint32  # DWORD* optional, out
): int32 {.importc: "SetupGetStringFieldA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupGetStringFieldA(
    INFCONTEXT* Context,   // INFCONTEXT*
    uint FieldIndex,   // DWORD
    char* ReturnBuffer,   // LPSTR optional, out
    uint ReturnBufferSize,   // DWORD
    uint* RequiredSize   // DWORD* optional, out
);
ccall((:SetupGetStringFieldA, "SETUPAPI.dll"), stdcall, Int32,
      (Ptr{INFCONTEXT}, UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}),
      Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
# Context : INFCONTEXT* -> Ptr{INFCONTEXT}
# FieldIndex : DWORD -> UInt32
# ReturnBuffer : LPSTR optional, out -> Ptr{UInt8}
# ReturnBufferSize : DWORD -> UInt32
# RequiredSize : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupGetStringFieldA(
    void* Context,
    uint32_t FieldIndex,
    char* ReturnBuffer,
    uint32_t ReturnBufferSize,
    uint32_t* RequiredSize);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
-- Context : INFCONTEXT*
-- FieldIndex : DWORD
-- ReturnBuffer : LPSTR optional, out
-- ReturnBufferSize : DWORD
-- RequiredSize : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupGetStringFieldA = lib.func('__stdcall', 'SetupGetStringFieldA', 'int32_t', ['void *', 'uint32_t', 'char *', 'uint32_t', 'uint32_t *']);
// SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
// Context : INFCONTEXT* -> 'void *'
// FieldIndex : DWORD -> 'uint32_t'
// ReturnBuffer : LPSTR optional, out -> 'char *'
// ReturnBufferSize : DWORD -> 'uint32_t'
// RequiredSize : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupGetStringFieldA: { parameters: ["pointer", "u32", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize)
// Context : INFCONTEXT* -> "pointer"
// FieldIndex : DWORD -> "u32"
// ReturnBuffer : LPSTR optional, out -> "buffer"
// ReturnBufferSize : DWORD -> "u32"
// RequiredSize : DWORD* optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetupGetStringFieldA(
    void* Context,
    uint32_t FieldIndex,
    char* ReturnBuffer,
    uint32_t ReturnBufferSize,
    uint32_t* RequiredSize);
C, "SETUPAPI.dll");
// $ffi->SetupGetStringFieldA(Context, FieldIndex, ReturnBuffer, ReturnBufferSize, RequiredSize);
// Context : INFCONTEXT*
// FieldIndex : DWORD
// ReturnBuffer : LPSTR optional, out
// ReturnBufferSize : DWORD
// RequiredSize : DWORD* optional, out
// 構造体/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 Setupapi extends StdCallLibrary {
    Setupapi INSTANCE = Native.load("setupapi", Setupapi.class, W32APIOptions.ASCII_OPTIONS);
    boolean SetupGetStringFieldA(
        Pointer Context,   // INFCONTEXT*
        int FieldIndex,   // DWORD
        byte[] ReturnBuffer,   // LPSTR optional, out
        int ReturnBufferSize,   // DWORD
        IntByReference RequiredSize   // DWORD* optional, out
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupGetStringFieldA = SetupGetStringFieldA(
    Context : INFCONTEXT*,   # INFCONTEXT*
    FieldIndex : UInt32,   # DWORD
    ReturnBuffer : UInt8*,   # LPSTR optional, out
    ReturnBufferSize : UInt32,   # DWORD
    RequiredSize : UInt32*   # DWORD* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetupGetStringFieldANative = Int32 Function(Pointer<Void>, Uint32, Pointer<Utf8>, Uint32, Pointer<Uint32>);
typedef SetupGetStringFieldADart = int Function(Pointer<Void>, int, Pointer<Utf8>, int, Pointer<Uint32>);
final SetupGetStringFieldA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupGetStringFieldANative, SetupGetStringFieldADart>('SetupGetStringFieldA');
// Context : INFCONTEXT* -> Pointer<Void>
// FieldIndex : DWORD -> Uint32
// ReturnBuffer : LPSTR optional, out -> Pointer<Utf8>
// ReturnBufferSize : DWORD -> Uint32
// RequiredSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupGetStringFieldA(
  Context: Pointer;   // INFCONTEXT*
  FieldIndex: DWORD;   // DWORD
  ReturnBuffer: PAnsiChar;   // LPSTR optional, out
  ReturnBufferSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupGetStringFieldA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetupGetStringFieldA"
  c_SetupGetStringFieldA :: Ptr () -> Word32 -> CString -> Word32 -> Ptr Word32 -> IO CInt
-- Context : INFCONTEXT* -> Ptr ()
-- FieldIndex : DWORD -> Word32
-- ReturnBuffer : LPSTR optional, out -> CString
-- ReturnBufferSize : DWORD -> Word32
-- RequiredSize : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setupgetstringfielda =
  foreign "SetupGetStringFieldA"
    ((ptr void) @-> uint32_t @-> string @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* Context : INFCONTEXT* -> (ptr void) *)
(* FieldIndex : DWORD -> uint32_t *)
(* ReturnBuffer : LPSTR optional, out -> string *)
(* ReturnBufferSize : DWORD -> uint32_t *)
(* RequiredSize : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library setupapi (t "SETUPAPI.dll"))
(cffi:use-foreign-library setupapi)

(cffi:defcfun ("SetupGetStringFieldA" setup-get-string-field-a :convention :stdcall) :int32
  (context :pointer)   ; INFCONTEXT*
  (field-index :uint32)   ; DWORD
  (return-buffer :pointer)   ; LPSTR optional, out
  (return-buffer-size :uint32)   ; DWORD
  (required-size :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetupGetStringFieldA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupGetStringFieldA(LPVOID Context, DWORD FieldIndex, LPSTR ReturnBuffer, DWORD ReturnBufferSize, LPVOID RequiredSize)');
# my $ret = $SetupGetStringFieldA->Call($Context, $FieldIndex, $ReturnBuffer, $ReturnBufferSize, $RequiredSize);
# Context : INFCONTEXT* -> LPVOID
# FieldIndex : DWORD -> DWORD
# ReturnBuffer : LPSTR optional, out -> LPSTR
# ReturnBufferSize : DWORD -> DWORD
# RequiredSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型