ホーム › Devices.DeviceAndDriverInstallation › SetupDiGetCustomDevicePropertyA

SetupDiGetCustomDevicePropertyA

関数

デバイスの指定したカスタムプロパティを取得する。

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

シグネチャ

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

BOOL SetupDiGetCustomDevicePropertyA(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    LPCSTR CustomPropertyName,
    DWORD Flags,
    DWORD* PropertyRegDataType,   // optional
    BYTE* PropertyBuffer,
    DWORD PropertyBufferSize,
    DWORD* RequiredSize   // optional
);

パラメーター

名前	型	方向	説明
DeviceInfoSet	HDEVINFO	in	カスタムデバイスプロパティを取得する対象のデバイスを表すデバイス情報要素を含む、デバイス情報セットへのハンドル。
DeviceInfoData	SP_DEVINFO_DATA*	in	DeviceInfoSet 内のデバイス情報要素を指定する SP_DEVINFO_DATA 構造体へのポインター。
CustomPropertyName	LPCSTR	in	カスタムプロパティを表すレジストリ値の名前。
Flags	DWORD	in	要求された情報をどのように返すかを示すフラグ値。このフラグには 0、または次のいずれかを指定できます。 DICUSTOMDEVPROP_MERGE_MULTISZ 設定されている場合、この関数はデバイスインスタンス固有のプロパティ値とハードウェア ID 固有のプロパティ値の両方を、REG_MULTI_SZ 型の文字列として連結して取得します。(詳細については、このリファレンスページの「解説」セクションを参照してください。)
PropertyRegDataType	DWORD*	outoptional	取得したプロパティのデータ型を受け取る DWORD 型の変数へのポインター。データ型は、レジストリのデータ型を表す REG_ プレフィックス付きの定数のいずれかで指定されます。このパラメーターは省略可能で、NULL を指定できます。
PropertyBuffer	BYTE*	out	要求されたプロパティ情報を受け取るバッファーへのポインター。
PropertyBufferSize	DWORD	in	PropertyBuffer バッファーのサイズ (バイト単位)。
RequiredSize	DWORD*	outoptional	要求された情報を受け取るために必要なバッファーのサイズ (バイト単位) を受け取る DWORD 型の変数へのポインター。このパラメーターは省略可能で、NULL を指定できます。このパラメーターを指定した場合、SetupDiGetCustomDeviceProperty は、PropertyBuffer バッファーが要求された情報を受け取るのに十分な大きさであるかどうかにかかわらず、必要なサイズを返します。

戻り値の型: BOOL

公式ドキュメント

SetupDiGetCustomDeviceProperty 関数は、指定されたカスタムデバイスプロパティをレジストリから取得します。(ANSI)

戻り値

操作が成功した場合、SetupDiGetCustomDeviceProperty は TRUE を返します。それ以外の場合、この関数は FALSE を返し、記録されたエラーは GetLastError の呼び出しによって取得できます。PropertyBuffer バッファーが要求された情報を受け取るのに十分な大きさでない場合、SetupDiGetCustomDeviceProperty は FALSE を返し、続けて GetLastError を呼び出すと ERROR_INSUFFICIENT_BUFFER が返されます。

解説(Remarks)

SetupDiGetCustomDeviceProperty は、単一のデバイスインスタンスに関連付けられたデバイスプロパティ、または特定のハードウェア ID に一致するすべてのデバイスに関連付けられたデバイスプロパティを取得します。(ハードウェア ID の詳細については、「デバイス識別文字列」を参照してください。)

ベンダーは、INF DDInstall.HW セクションで INF AddReg ディレクティブを使用し、レジストリのルートとして HKR を指定することで、デバイスインスタンスのプロパティを設定できます。

ハードウェア ID に対するプロパティを設定できるのはシステムのみです。システムは、一部のハードウェア ID に対して "Icon" プロパティを提供します。

この関数は、まず指定されたデバイスインスタンスに対して指定されたプロパティが存在するかどうかを確認します。存在する場合は、そのプロパティの値を返します。存在しない場合は、指定されたデバイスインスタンスのハードウェア ID に一致するすべてのデバイスに対してそのプロパティが存在するかどうかを確認します。存在する場合は、そのプロパティの値を返します。Flags に DICUSTOMDEVPROP_MERGE_MULTISZ が設定されている場合、この関数は、デバイスインスタンスとハードウェア ID の両方に関連付けられたプロパティ値が存在すれば、その両方を返します。

メモ

setupapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして SetupDiGetCustomDeviceProperty を定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL SetupDiGetCustomDevicePropertyA(
    HDEVINFO DeviceInfoSet,
    SP_DEVINFO_DATA* DeviceInfoData,
    LPCSTR CustomPropertyName,
    DWORD Flags,
    DWORD* PropertyRegDataType,   // optional
    BYTE* PropertyBuffer,
    DWORD PropertyBufferSize,
    DWORD* RequiredSize   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("SETUPAPI.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetupDiGetCustomDevicePropertyA(
    IntPtr DeviceInfoSet,   // HDEVINFO
    IntPtr DeviceInfoData,   // SP_DEVINFO_DATA*
    [MarshalAs(UnmanagedType.LPStr)] string CustomPropertyName,   // LPCSTR
    uint Flags,   // DWORD
    IntPtr PropertyRegDataType,   // DWORD* optional, out
    IntPtr PropertyBuffer,   // BYTE* out
    uint PropertyBufferSize,   // DWORD
    IntPtr RequiredSize   // DWORD* optional, out
);

<DllImport("SETUPAPI.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetupDiGetCustomDevicePropertyA(
    DeviceInfoSet As IntPtr,   ' HDEVINFO
    DeviceInfoData As IntPtr,   ' SP_DEVINFO_DATA*
    <MarshalAs(UnmanagedType.LPStr)> CustomPropertyName As String,   ' LPCSTR
    Flags As UInteger,   ' DWORD
    PropertyRegDataType As IntPtr,   ' DWORD* optional, out
    PropertyBuffer As IntPtr,   ' BYTE* out
    PropertyBufferSize As UInteger,   ' DWORD
    RequiredSize As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' DeviceInfoSet : HDEVINFO
' DeviceInfoData : SP_DEVINFO_DATA*
' CustomPropertyName : LPCSTR
' Flags : DWORD
' PropertyRegDataType : DWORD* optional, out
' PropertyBuffer : BYTE* out
' PropertyBufferSize : DWORD
' RequiredSize : DWORD* optional, out
Declare PtrSafe Function SetupDiGetCustomDevicePropertyA Lib "setupapi" ( _
    ByVal DeviceInfoSet As LongPtr, _
    ByVal DeviceInfoData As LongPtr, _
    ByVal CustomPropertyName As String, _
    ByVal Flags As Long, _
    ByVal PropertyRegDataType As LongPtr, _
    ByVal PropertyBuffer As LongPtr, _
    ByVal PropertyBufferSize 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

SetupDiGetCustomDevicePropertyA = ctypes.windll.setupapi.SetupDiGetCustomDevicePropertyA
SetupDiGetCustomDevicePropertyA.restype = wintypes.BOOL
SetupDiGetCustomDevicePropertyA.argtypes = [
    ctypes.c_ssize_t,  # DeviceInfoSet : HDEVINFO
    ctypes.c_void_p,  # DeviceInfoData : SP_DEVINFO_DATA*
    wintypes.LPCSTR,  # CustomPropertyName : LPCSTR
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(wintypes.DWORD),  # PropertyRegDataType : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # PropertyBuffer : BYTE* out
    wintypes.DWORD,  # PropertyBufferSize : 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')
SetupDiGetCustomDevicePropertyA = Fiddle::Function.new(
  lib['SetupDiGetCustomDevicePropertyA'],
  [
    Fiddle::TYPE_INTPTR_T,  # DeviceInfoSet : HDEVINFO
    Fiddle::TYPE_VOIDP,  # DeviceInfoData : SP_DEVINFO_DATA*
    Fiddle::TYPE_VOIDP,  # CustomPropertyName : LPCSTR
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # PropertyRegDataType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # PropertyBuffer : BYTE* out
    -Fiddle::TYPE_INT,  # PropertyBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # RequiredSize : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "setupapi")]
extern "system" {
    fn SetupDiGetCustomDevicePropertyA(
        DeviceInfoSet: isize,  // HDEVINFO
        DeviceInfoData: *mut SP_DEVINFO_DATA,  // SP_DEVINFO_DATA*
        CustomPropertyName: *const u8,  // LPCSTR
        Flags: u32,  // DWORD
        PropertyRegDataType: *mut u32,  // DWORD* optional, out
        PropertyBuffer: *mut u8,  // BYTE* out
        PropertyBufferSize: 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 SetupDiGetCustomDevicePropertyA(IntPtr DeviceInfoSet, IntPtr DeviceInfoData, [MarshalAs(UnmanagedType.LPStr)] string CustomPropertyName, uint Flags, IntPtr PropertyRegDataType, IntPtr PropertyBuffer, uint PropertyBufferSize, IntPtr RequiredSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'SETUPAPI_SetupDiGetCustomDevicePropertyA' -Namespace Win32 -PassThru
# $api::SetupDiGetCustomDevicePropertyA(DeviceInfoSet, DeviceInfoData, CustomPropertyName, Flags, PropertyRegDataType, PropertyBuffer, PropertyBufferSize, RequiredSize)

#uselib "SETUPAPI.dll"
#func global SetupDiGetCustomDevicePropertyA "SetupDiGetCustomDevicePropertyA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; SetupDiGetCustomDevicePropertyA DeviceInfoSet, varptr(DeviceInfoData), CustomPropertyName, Flags, varptr(PropertyRegDataType), varptr(PropertyBuffer), PropertyBufferSize, varptr(RequiredSize)   ; 戻り値は stat
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; CustomPropertyName : LPCSTR -> "sptr"
; Flags : DWORD -> "sptr"
; PropertyRegDataType : DWORD* optional, out -> "sptr"
; PropertyBuffer : BYTE* out -> "sptr"
; PropertyBufferSize : DWORD -> "sptr"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetCustomDevicePropertyA "SetupDiGetCustomDevicePropertyA" sptr, var, str, int, var, var, int, var
; res = SetupDiGetCustomDevicePropertyA(DeviceInfoSet, DeviceInfoData, CustomPropertyName, Flags, PropertyRegDataType, PropertyBuffer, PropertyBufferSize, RequiredSize)
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "var"
; CustomPropertyName : LPCSTR -> "str"
; Flags : DWORD -> "int"
; PropertyRegDataType : DWORD* optional, out -> "var"
; PropertyBuffer : BYTE* out -> "var"
; PropertyBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "SETUPAPI.dll"
#cfunc global SetupDiGetCustomDevicePropertyA "SetupDiGetCustomDevicePropertyA" sptr, sptr, str, int, sptr, sptr, int, sptr
; res = SetupDiGetCustomDevicePropertyA(DeviceInfoSet, varptr(DeviceInfoData), CustomPropertyName, Flags, varptr(PropertyRegDataType), varptr(PropertyBuffer), PropertyBufferSize, varptr(RequiredSize))
; DeviceInfoSet : HDEVINFO -> "sptr"
; DeviceInfoData : SP_DEVINFO_DATA* -> "sptr"
; CustomPropertyName : LPCSTR -> "str"
; Flags : DWORD -> "int"
; PropertyRegDataType : DWORD* optional, out -> "sptr"
; PropertyBuffer : BYTE* out -> "sptr"
; PropertyBufferSize : DWORD -> "int"
; RequiredSize : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。