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

SetupDiGetHwProfileFriendlyNameExA

関数
指定マシンのハードウェアプロファイル名を取得する。
DLLSETUPAPI.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL SetupDiGetHwProfileFriendlyNameExA(
    DWORD HwProfile,
    LPSTR FriendlyName,
    DWORD FriendlyNameSize,
    DWORD* RequiredSize,   // optional
    LPCSTR MachineName,   // optional
    void* Reserved   // optional
);

パラメーター

名前方向
HwProfileDWORDin
FriendlyNameLPSTRout
FriendlyNameSizeDWORDin
RequiredSizeDWORD*outoptional
MachineNameLPCSTRinoptional
Reservedvoid*optional

戻り値の型: BOOL

各言語での呼び出し定義

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

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

SetupDiGetHwProfileFriendlyNameExA = ctypes.windll.setupapi.SetupDiGetHwProfileFriendlyNameExA
SetupDiGetHwProfileFriendlyNameExA.restype = wintypes.BOOL
SetupDiGetHwProfileFriendlyNameExA.argtypes = [
    wintypes.DWORD,  # HwProfile : DWORD
    wintypes.LPSTR,  # FriendlyName : LPSTR out
    wintypes.DWORD,  # FriendlyNameSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # RequiredSize : DWORD* optional, out
    wintypes.LPCSTR,  # MachineName : LPCSTR optional
    ctypes.POINTER(None),  # Reserved : void* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('SETUPAPI.dll')
SetupDiGetHwProfileFriendlyNameExA = Fiddle::Function.new(
  lib['SetupDiGetHwProfileFriendlyNameExA'],
  [
    -Fiddle::TYPE_INT,  # HwProfile : DWORD
    Fiddle::TYPE_VOIDP,  # FriendlyName : LPSTR out
    -Fiddle::TYPE_INT,  # FriendlyNameSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # MachineName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # Reserved : void* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetHwProfileFriendlyNameExA(
        HwProfile: u32,  // DWORD
        FriendlyName: *mut u8,  // LPSTR out
        FriendlyNameSize: u32,  // DWORD
        RequiredSize: *mut u32,  // DWORD* optional, out
        MachineName: *const u8,  // LPCSTR optional
        Reserved: *mut ()  // void* optional
    ) -> 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 SetupDiGetHwProfileFriendlyNameExA(uint HwProfile, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder FriendlyName, uint FriendlyNameSize, IntPtr RequiredSize, [MarshalAs(UnmanagedType.LPStr)] string MachineName, IntPtr Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetHwProfileFriendlyNameExA' -Namespace Win32 -PassThru
# $api::SetupDiGetHwProfileFriendlyNameExA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize, MachineName, Reserved)
#uselib "SETUPAPI.dll"
#func global SetupDiGetHwProfileFriendlyNameExA "SetupDiGetHwProfileFriendlyNameExA" sptr, sptr, sptr, sptr, sptr, sptr
; SetupDiGetHwProfileFriendlyNameExA HwProfile, varptr(FriendlyName), FriendlyNameSize, varptr(RequiredSize), MachineName, Reserved   ; 戻り値は stat
; HwProfile : DWORD -> "sptr"
; FriendlyName : LPSTR out -> "sptr"
; FriendlyNameSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; MachineName : LPCSTR optional -> "sptr"
; Reserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetHwProfileFriendlyNameExA "SetupDiGetHwProfileFriendlyNameExA" int, var, int, var, str, sptr
; res = SetupDiGetHwProfileFriendlyNameExA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize, MachineName, Reserved)
; HwProfile : DWORD -> "int"
; FriendlyName : LPSTR out -> "var"
; FriendlyNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetHwProfileFriendlyNameExA(DWORD HwProfile, LPSTR FriendlyName, DWORD FriendlyNameSize, DWORD* RequiredSize, LPCSTR MachineName, void* Reserved)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetHwProfileFriendlyNameExA "SetupDiGetHwProfileFriendlyNameExA" int, var, int, var, str, intptr
; res = SetupDiGetHwProfileFriendlyNameExA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize, MachineName, Reserved)
; HwProfile : DWORD -> "int"
; FriendlyName : LPSTR out -> "var"
; FriendlyNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; MachineName : LPCSTR optional -> "str"
; Reserved : void* optional -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetHwProfileFriendlyNameExA = setupapi.NewProc("SetupDiGetHwProfileFriendlyNameExA")
)

// HwProfile (DWORD), FriendlyName (LPSTR out), FriendlyNameSize (DWORD), RequiredSize (DWORD* optional, out), MachineName (LPCSTR optional), Reserved (void* optional)
r1, _, err := procSetupDiGetHwProfileFriendlyNameExA.Call(
	uintptr(HwProfile),
	uintptr(FriendlyName),
	uintptr(FriendlyNameSize),
	uintptr(RequiredSize),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(MachineName))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetHwProfileFriendlyNameExA(
  HwProfile: DWORD;   // DWORD
  FriendlyName: PAnsiChar;   // LPSTR out
  FriendlyNameSize: DWORD;   // DWORD
  RequiredSize: Pointer;   // DWORD* optional, out
  MachineName: PAnsiChar;   // LPCSTR optional
  Reserved: Pointer   // void* optional
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetHwProfileFriendlyNameExA';
result := DllCall("SETUPAPI\SetupDiGetHwProfileFriendlyNameExA"
    , "UInt", HwProfile   ; DWORD
    , "Ptr", FriendlyName   ; LPSTR out
    , "UInt", FriendlyNameSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "AStr", MachineName   ; LPCSTR optional
    , "Ptr", Reserved   ; void* optional
    , "Int")   ; return: BOOL
●SetupDiGetHwProfileFriendlyNameExA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize, MachineName, Reserved) = DLL("SETUPAPI.dll", "bool SetupDiGetHwProfileFriendlyNameExA(dword, char*, dword, void*, char*, void*)")
# 呼び出し: SetupDiGetHwProfileFriendlyNameExA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize, MachineName, Reserved)
# HwProfile : DWORD -> "dword"
# FriendlyName : LPSTR out -> "char*"
# FriendlyNameSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# MachineName : LPCSTR optional -> "char*"
# Reserved : void* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。