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

SetupDiGetHwProfileFriendlyNameA

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

シグネチャ

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

BOOL SetupDiGetHwProfileFriendlyNameA(
    DWORD HwProfile,
    LPSTR FriendlyName,
    DWORD FriendlyNameSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前方向説明
HwProfileDWORDinフレンドリ名を取得するハードウェアプロファイル番号。0で現在のプロファイル。
FriendlyNameLPSTRoutプロファイルのフレンドリ名を受け取るバッファ(ANSI)。
FriendlyNameSizeDWORDinFriendlyNameバッファの文字数。終端NUL含む。
RequiredSizeDWORD*outoptional名前に必要な文字数を受け取るポインタ。不足判定に使う。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

extern "setupapi" fn SetupDiGetHwProfileFriendlyNameA(
    HwProfile: u32, // DWORD
    FriendlyName: [*c]u8, // LPSTR out
    FriendlyNameSize: u32, // DWORD
    RequiredSize: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SetupDiGetHwProfileFriendlyNameA(
    HwProfile: uint32,  # DWORD
    FriendlyName: ptr char,  # LPSTR out
    FriendlyNameSize: uint32,  # DWORD
    RequiredSize: ptr uint32  # DWORD* optional, out
): int32 {.importc: "SetupDiGetHwProfileFriendlyNameA", stdcall, dynlib: "SETUPAPI.dll".}
pragma(lib, "setupapi");
extern(Windows)
int SetupDiGetHwProfileFriendlyNameA(
    uint HwProfile,   // DWORD
    char* FriendlyName,   // LPSTR out
    uint FriendlyNameSize,   // DWORD
    uint* RequiredSize   // DWORD* optional, out
);
ccall((:SetupDiGetHwProfileFriendlyNameA, "SETUPAPI.dll"), stdcall, Int32,
      (UInt32, Ptr{UInt8}, UInt32, Ptr{UInt32}),
      HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
# HwProfile : DWORD -> UInt32
# FriendlyName : LPSTR out -> Ptr{UInt8}
# FriendlyNameSize : DWORD -> UInt32
# RequiredSize : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetupDiGetHwProfileFriendlyNameA(
    uint32_t HwProfile,
    char* FriendlyName,
    uint32_t FriendlyNameSize,
    uint32_t* RequiredSize);
]]
local setupapi = ffi.load("setupapi")
-- setupapi.SetupDiGetHwProfileFriendlyNameA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
-- HwProfile : DWORD
-- FriendlyName : LPSTR out
-- FriendlyNameSize : DWORD
-- RequiredSize : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('SETUPAPI.dll');
const SetupDiGetHwProfileFriendlyNameA = lib.func('__stdcall', 'SetupDiGetHwProfileFriendlyNameA', 'int32_t', ['uint32_t', 'char *', 'uint32_t', 'uint32_t *']);
// SetupDiGetHwProfileFriendlyNameA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
// HwProfile : DWORD -> 'uint32_t'
// FriendlyName : LPSTR out -> 'char *'
// FriendlyNameSize : DWORD -> 'uint32_t'
// RequiredSize : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("SETUPAPI.dll", {
  SetupDiGetHwProfileFriendlyNameA: { parameters: ["u32", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetupDiGetHwProfileFriendlyNameA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize)
// HwProfile : DWORD -> "u32"
// FriendlyName : LPSTR out -> "buffer"
// FriendlyNameSize : 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 SetupDiGetHwProfileFriendlyNameA(
    uint32_t HwProfile,
    char* FriendlyName,
    uint32_t FriendlyNameSize,
    uint32_t* RequiredSize);
C, "SETUPAPI.dll");
// $ffi->SetupDiGetHwProfileFriendlyNameA(HwProfile, FriendlyName, FriendlyNameSize, RequiredSize);
// HwProfile : DWORD
// FriendlyName : LPSTR out
// FriendlyNameSize : 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 SetupDiGetHwProfileFriendlyNameA(
        int HwProfile,   // DWORD
        byte[] FriendlyName,   // LPSTR out
        int FriendlyNameSize,   // DWORD
        IntByReference RequiredSize   // DWORD* optional, out
    );
}
@[Link("setupapi")]
lib LibSETUPAPI
  fun SetupDiGetHwProfileFriendlyNameA = SetupDiGetHwProfileFriendlyNameA(
    HwProfile : UInt32,   # DWORD
    FriendlyName : UInt8*,   # LPSTR out
    FriendlyNameSize : 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 SetupDiGetHwProfileFriendlyNameANative = Int32 Function(Uint32, Pointer<Utf8>, Uint32, Pointer<Uint32>);
typedef SetupDiGetHwProfileFriendlyNameADart = int Function(int, Pointer<Utf8>, int, Pointer<Uint32>);
final SetupDiGetHwProfileFriendlyNameA = DynamicLibrary.open('SETUPAPI.dll')
    .lookupFunction<SetupDiGetHwProfileFriendlyNameANative, SetupDiGetHwProfileFriendlyNameADart>('SetupDiGetHwProfileFriendlyNameA');
// HwProfile : DWORD -> Uint32
// FriendlyName : LPSTR out -> Pointer<Utf8>
// FriendlyNameSize : DWORD -> Uint32
// RequiredSize : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetupDiGetHwProfileFriendlyNameA(
  HwProfile: DWORD;   // DWORD
  FriendlyName: PAnsiChar;   // LPSTR out
  FriendlyNameSize: DWORD;   // DWORD
  RequiredSize: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'SETUPAPI.dll' name 'SetupDiGetHwProfileFriendlyNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setupdigethwprofilefriendlynamea =
  foreign "SetupDiGetHwProfileFriendlyNameA"
    (uint32_t @-> string @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* HwProfile : DWORD -> uint32_t *)
(* FriendlyName : LPSTR out -> string *)
(* FriendlyNameSize : 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 ("SetupDiGetHwProfileFriendlyNameA" setup-di-get-hw-profile-friendly-name-a :convention :stdcall) :int32
  (hw-profile :uint32)   ; DWORD
  (friendly-name :pointer)   ; LPSTR out
  (friendly-name-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 $SetupDiGetHwProfileFriendlyNameA = Win32::API::More->new('SETUPAPI',
    'BOOL SetupDiGetHwProfileFriendlyNameA(DWORD HwProfile, LPSTR FriendlyName, DWORD FriendlyNameSize, LPVOID RequiredSize)');
# my $ret = $SetupDiGetHwProfileFriendlyNameA->Call($HwProfile, $FriendlyName, $FriendlyNameSize, $RequiredSize);
# HwProfile : DWORD -> DWORD
# FriendlyName : LPSTR out -> LPSTR
# FriendlyNameSize : DWORD -> DWORD
# RequiredSize : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API