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

SetupDiGetHwProfileFriendlyNameW

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

シグネチャ

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

BOOL SetupDiGetHwProfileFriendlyNameW(
    DWORD HwProfile,
    LPWSTR FriendlyName,
    DWORD FriendlyNameSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前方向
HwProfileDWORDin
FriendlyNameLPWSTRout
FriendlyNameSizeDWORDin
RequiredSizeDWORD*outoptional

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetupDiGetHwProfileFriendlyNameW(
    DWORD HwProfile,
    LPWSTR FriendlyName,
    DWORD FriendlyNameSize,
    DWORD* RequiredSize   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetHwProfileFriendlyNameW(
    uint HwProfile,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder FriendlyName,   // LPWSTR out
    uint FriendlyNameSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);
<DllImport("SETUPAPI.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetHwProfileFriendlyNameW(
    HwProfile As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> FriendlyName As System.Text.StringBuilder,   ' LPWSTR out
    FriendlyNameSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As Boolean
End Function
' HwProfile : DWORD
' FriendlyName : LPWSTR out
' FriendlyNameSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetHwProfileFriendlyNameW Lib "setupapi" ( _
    ByVal HwProfile As Long, _
    ByVal FriendlyName As LongPtr, _
    ByVal FriendlyNameSize 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

SetupDiGetHwProfileFriendlyNameW = ctypes.windll.setupapi.SetupDiGetHwProfileFriendlyNameW
SetupDiGetHwProfileFriendlyNameW.restype = wintypes.BOOL
SetupDiGetHwProfileFriendlyNameW.argtypes = [
    wintypes.DWORD,  # HwProfile : DWORD
    wintypes.LPWSTR,  # FriendlyName : LPWSTR out
    wintypes.DWORD,  # FriendlyNameSize : 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')
SetupDiGetHwProfileFriendlyNameW = Fiddle::Function.new(
  lib['SetupDiGetHwProfileFriendlyNameW'],
  [
    -Fiddle::TYPE_INT,  # HwProfile : DWORD
    Fiddle::TYPE_VOIDP,  # FriendlyName : LPWSTR out
    -Fiddle::TYPE_INT,  # FriendlyNameSize : 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 SetupDiGetHwProfileFriendlyNameW(
        HwProfile: u32,  // DWORD
        FriendlyName: *mut u16,  // LPWSTR out
        FriendlyNameSize: 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 SetupDiGetHwProfileFriendlyNameW(uint HwProfile, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder FriendlyName, uint FriendlyNameSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetHwProfileFriendlyNameW' -Namespace Win32 -PassThru
# $api::SetupDiGetHwProfileFriendlyNameW(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
#uselib "SETUPAPI.dll"
#func global SetupDiGetHwProfileFriendlyNameW "SetupDiGetHwProfileFriendlyNameW" wptr, wptr, wptr, wptr
; SetupDiGetHwProfileFriendlyNameW HwProfile, varptr(FriendlyName), FriendlyNameSize, varptr(RequiredSize)   ; 戻り値は stat
; HwProfile : DWORD -> "wptr"
; FriendlyName : LPWSTR out -> "wptr"
; FriendlyNameSize : DWORD -> "wptr"
; RequiredSize : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetHwProfileFriendlyNameW "SetupDiGetHwProfileFriendlyNameW" int, var, int, var
; res = SetupDiGetHwProfileFriendlyNameW(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
; HwProfile : DWORD -> "int"
; FriendlyName : LPWSTR out -> "var"
; FriendlyNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetupDiGetHwProfileFriendlyNameW(DWORD HwProfile, LPWSTR FriendlyName, DWORD FriendlyNameSize, DWORD* RequiredSize)
#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetHwProfileFriendlyNameW "SetupDiGetHwProfileFriendlyNameW" int, var, int, var
; res = SetupDiGetHwProfileFriendlyNameW(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
; HwProfile : DWORD -> "int"
; FriendlyName : LPWSTR out -> "var"
; FriendlyNameSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	setupapi = windows.NewLazySystemDLL("SETUPAPI.dll")
	procSetupDiGetHwProfileFriendlyNameW = setupapi.NewProc("SetupDiGetHwProfileFriendlyNameW")
)

// HwProfile (DWORD), FriendlyName (LPWSTR out), FriendlyNameSize (DWORD), RequiredSize (DWORD* optional, out)
r1, _, err := procSetupDiGetHwProfileFriendlyNameW.Call(
	uintptr(HwProfile),
	uintptr(FriendlyName),
	uintptr(FriendlyNameSize),
	uintptr(RequiredSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetupDiGetHwProfileFriendlyNameW(
  HwProfile: DWORD;   // DWORD
  FriendlyName: PWideChar;   // LPWSTR out
  FriendlyNameSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetHwProfileFriendlyNameW';
result := DllCall("SETUPAPI\SetupDiGetHwProfileFriendlyNameW"
    , "UInt", HwProfile   ; DWORD
    , "Ptr", FriendlyName   ; LPWSTR out
    , "UInt", FriendlyNameSize   ; DWORD
    , "Ptr", RequiredSize   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●SetupDiGetHwProfileFriendlyNameW(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize) = DLL("SETUPAPI.dll", "bool SetupDiGetHwProfileFriendlyNameW(dword, char*, dword, void*)")
# 呼び出し: SetupDiGetHwProfileFriendlyNameW(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
# HwProfile : DWORD -> "dword"
# FriendlyName : LPWSTR out -> "char*"
# FriendlyNameSize : DWORD -> "dword"
# RequiredSize : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。