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

CM_Get_DevNode_Custom_PropertyA

関数
デバイスノードの指定したカスタムプロパティを取得する。
DLLCFGMGR32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

CONFIGRET CM_Get_DevNode_Custom_PropertyA(
    DWORD dnDevInst,
    LPCSTR pszCustomPropertyName,
    DWORD* pulRegDataType,   // optional
    void* Buffer,   // optional
    DWORD* pulLength,
    DWORD ulFlags
);

パラメーター

名前型方向説明
dnDevInstDWORDinカスタムプロパティを取得する対象デバイスインスタンス(DEVINST)を指定する。
pszCustomPropertyNameLPCSTRin取得するカスタムプロパティ名を表すNULL終端のANSI文字列を指定する。
pulRegDataTypeDWORD*outoptional取得した値のレジストリデータ型を受け取るDWORDへのポインター。不要ならNULL可。
Buffervoid*outoptionalプロパティ値を受け取るバッファーへのポインター。サイズ問い合わせ時はNULL可。
pulLengthDWORD*inout入力時はバッファーサイズ、出力時は必要サイズ(バイト)を示すDWORDへのポインター。
ulFlagsDWORDin動作を制御するフラグ。通常は0を指定する。

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Get_DevNode_Custom_PropertyA(
    DWORD dnDevInst,
    LPCSTR pszCustomPropertyName,
    DWORD* pulRegDataType,   // optional
    void* Buffer,   // optional
    DWORD* pulLength,
    DWORD ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CM_Get_DevNode_Custom_PropertyA(
    uint dnDevInst,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string pszCustomPropertyName,   // LPCSTR
    IntPtr pulRegDataType,   // DWORD* optional, out
    IntPtr Buffer,   // void* optional, out
    ref uint pulLength,   // DWORD* in/out
    uint ulFlags   // DWORD
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CM_Get_DevNode_Custom_PropertyA(
    dnDevInst As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszCustomPropertyName As String,   ' LPCSTR
    pulRegDataType As IntPtr,   ' DWORD* optional, out
    Buffer As IntPtr,   ' void* optional, out
    ByRef pulLength As UInteger,   ' DWORD* in/out
    ulFlags As UInteger   ' DWORD
) As UInteger
End Function
' dnDevInst : DWORD
' pszCustomPropertyName : LPCSTR
' pulRegDataType : DWORD* optional, out
' Buffer : void* optional, out
' pulLength : DWORD* in/out
' ulFlags : DWORD
Declare PtrSafe Function CM_Get_DevNode_Custom_PropertyA Lib "cfgmgr32" ( _
    ByVal dnDevInst As Long, _
    ByVal pszCustomPropertyName As String, _
    ByVal pulRegDataType As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByRef pulLength As Long, _
    ByVal ulFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

CM_Get_DevNode_Custom_PropertyA = ctypes.windll.cfgmgr32.CM_Get_DevNode_Custom_PropertyA
CM_Get_DevNode_Custom_PropertyA.restype = wintypes.DWORD
CM_Get_DevNode_Custom_PropertyA.argtypes = [
    wintypes.DWORD,  # dnDevInst : DWORD
    wintypes.LPCSTR,  # pszCustomPropertyName : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pulRegDataType : DWORD* optional, out
    ctypes.POINTER(None),  # Buffer : void* optional, out
    ctypes.POINTER(wintypes.DWORD),  # pulLength : DWORD* in/out
    wintypes.DWORD,  # ulFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Get_DevNode_Custom_PropertyA = Fiddle::Function.new(
  lib['CM_Get_DevNode_Custom_PropertyA'],
  [
    -Fiddle::TYPE_INT,  # dnDevInst : DWORD
    Fiddle::TYPE_VOIDP,  # pszCustomPropertyName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pulRegDataType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # Buffer : void* optional, out
    Fiddle::TYPE_VOIDP,  # pulLength : DWORD* in/out
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Get_DevNode_Custom_PropertyA(
        dnDevInst: u32,  // DWORD
        pszCustomPropertyName: *const u8,  // LPCSTR
        pulRegDataType: *mut u32,  // DWORD* optional, out
        Buffer: *mut (),  // void* optional, out
        pulLength: *mut u32,  // DWORD* in/out
        ulFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi)]
public static extern uint CM_Get_DevNode_Custom_PropertyA(uint dnDevInst, [MarshalAs(UnmanagedType.LPStr)] string pszCustomPropertyName, IntPtr pulRegDataType, IntPtr Buffer, ref uint pulLength, uint ulFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Get_DevNode_Custom_PropertyA' -Namespace Win32 -PassThru
# $api::CM_Get_DevNode_Custom_PropertyA(dnDevInst, pszCustomPropertyName, pulRegDataType, Buffer, pulLength, ulFlags)
#uselib "CFGMGR32.dll"
#func global CM_Get_DevNode_Custom_PropertyA "CM_Get_DevNode_Custom_PropertyA" sptr, sptr, sptr, sptr, sptr, sptr
; CM_Get_DevNode_Custom_PropertyA dnDevInst, pszCustomPropertyName, varptr(pulRegDataType), Buffer, varptr(pulLength), ulFlags   ; 戻り値は stat
; dnDevInst : DWORD -> "sptr"
; pszCustomPropertyName : LPCSTR -> "sptr"
; pulRegDataType : DWORD* optional, out -> "sptr"
; Buffer : void* optional, out -> "sptr"
; pulLength : DWORD* in/out -> "sptr"
; ulFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_DevNode_Custom_PropertyA "CM_Get_DevNode_Custom_PropertyA" int, str, var, sptr, var, int
; res = CM_Get_DevNode_Custom_PropertyA(dnDevInst, pszCustomPropertyName, pulRegDataType, Buffer, pulLength, ulFlags)
; dnDevInst : DWORD -> "int"
; pszCustomPropertyName : LPCSTR -> "str"
; pulRegDataType : DWORD* optional, out -> "var"
; Buffer : void* optional, out -> "sptr"
; pulLength : DWORD* in/out -> "var"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; CONFIGRET CM_Get_DevNode_Custom_PropertyA(DWORD dnDevInst, LPCSTR pszCustomPropertyName, DWORD* pulRegDataType, void* Buffer, DWORD* pulLength, DWORD ulFlags)
#uselib "CFGMGR32.dll"
#cfunc global CM_Get_DevNode_Custom_PropertyA "CM_Get_DevNode_Custom_PropertyA" int, str, var, intptr, var, int
; res = CM_Get_DevNode_Custom_PropertyA(dnDevInst, pszCustomPropertyName, pulRegDataType, Buffer, pulLength, ulFlags)
; dnDevInst : DWORD -> "int"
; pszCustomPropertyName : LPCSTR -> "str"
; pulRegDataType : DWORD* optional, out -> "var"
; Buffer : void* optional, out -> "intptr"
; pulLength : DWORD* in/out -> "var"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Get_DevNode_Custom_PropertyA = cfgmgr32.NewProc("CM_Get_DevNode_Custom_PropertyA")
)

// dnDevInst (DWORD), pszCustomPropertyName (LPCSTR), pulRegDataType (DWORD* optional, out), Buffer (void* optional, out), pulLength (DWORD* in/out), ulFlags (DWORD)
r1, _, err := procCM_Get_DevNode_Custom_PropertyA.Call(
	uintptr(dnDevInst),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszCustomPropertyName))),
	uintptr(pulRegDataType),
	uintptr(Buffer),
	uintptr(pulLength),
	uintptr(ulFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // CONFIGRET
function CM_Get_DevNode_Custom_PropertyA(
  dnDevInst: DWORD;   // DWORD
  pszCustomPropertyName: PAnsiChar;   // LPCSTR
  pulRegDataType: Pointer;   // DWORD* optional, out
  Buffer: Pointer;   // void* optional, out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_DevNode_Custom_PropertyA';
result := DllCall("CFGMGR32\CM_Get_DevNode_Custom_PropertyA"
    , "UInt", dnDevInst   ; DWORD
    , "AStr", pszCustomPropertyName   ; LPCSTR
    , "Ptr", pulRegDataType   ; DWORD* optional, out
    , "Ptr", Buffer   ; void* optional, out
    , "Ptr", pulLength   ; DWORD* in/out
    , "UInt", ulFlags   ; DWORD
    , "UInt")   ; return: CONFIGRET
●CM_Get_DevNode_Custom_PropertyA(dnDevInst, pszCustomPropertyName, pulRegDataType, Buffer, pulLength, ulFlags) = DLL("CFGMGR32.dll", "dword CM_Get_DevNode_Custom_PropertyA(dword, char*, void*, void*, void*, dword)")
# 呼び出し: CM_Get_DevNode_Custom_PropertyA(dnDevInst, pszCustomPropertyName, pulRegDataType, Buffer, pulLength, ulFlags)
# dnDevInst : DWORD -> "dword"
# pszCustomPropertyName : LPCSTR -> "char*"
# pulRegDataType : DWORD* optional, out -> "void*"
# Buffer : void* optional, out -> "void*"
# pulLength : DWORD* in/out -> "void*"
# ulFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef CM_Get_DevNode_Custom_PropertyANative = Uint32 Function(Uint32, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>, Uint32);
typedef CM_Get_DevNode_Custom_PropertyADart = int Function(int, Pointer<Utf8>, Pointer<Uint32>, Pointer<Void>, Pointer<Uint32>, int);
final CM_Get_DevNode_Custom_PropertyA = DynamicLibrary.open('CFGMGR32.dll')
    .lookupFunction<CM_Get_DevNode_Custom_PropertyANative, CM_Get_DevNode_Custom_PropertyADart>('CM_Get_DevNode_Custom_PropertyA');
// dnDevInst : DWORD -> Uint32
// pszCustomPropertyName : LPCSTR -> Pointer<Utf8>
// pulRegDataType : DWORD* optional, out -> Pointer<Uint32>
// Buffer : void* optional, out -> Pointer<Void>
// pulLength : DWORD* in/out -> Pointer<Uint32>
// ulFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CM_Get_DevNode_Custom_PropertyA(
  dnDevInst: DWORD;   // DWORD
  pszCustomPropertyName: PAnsiChar;   // LPCSTR
  pulRegDataType: Pointer;   // DWORD* optional, out
  Buffer: Pointer;   // void* optional, out
  pulLength: Pointer;   // DWORD* in/out
  ulFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Get_DevNode_Custom_PropertyA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CM_Get_DevNode_Custom_PropertyA"
  c_CM_Get_DevNode_Custom_PropertyA :: Word32 -> CString -> Ptr Word32 -> Ptr () -> Ptr Word32 -> Word32 -> IO Word32
-- dnDevInst : DWORD -> Word32
-- pszCustomPropertyName : LPCSTR -> CString
-- pulRegDataType : DWORD* optional, out -> Ptr Word32
-- Buffer : void* optional, out -> Ptr ()
-- pulLength : DWORD* in/out -> Ptr Word32
-- ulFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_get_devnode_custom_propertya =
  foreign "CM_Get_DevNode_Custom_PropertyA"
    (uint32_t @-> string @-> (ptr uint32_t) @-> (ptr void) @-> (ptr uint32_t) @-> uint32_t @-> returning uint32_t)
(* dnDevInst : DWORD -> uint32_t *)
(* pszCustomPropertyName : LPCSTR -> string *)
(* pulRegDataType : DWORD* optional, out -> (ptr uint32_t) *)
(* Buffer : void* optional, out -> (ptr void) *)
(* pulLength : DWORD* in/out -> (ptr uint32_t) *)
(* ulFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library cfgmgr32 (t "CFGMGR32.dll"))
(cffi:use-foreign-library cfgmgr32)

(cffi:defcfun ("CM_Get_DevNode_Custom_PropertyA" cm-get-dev-node-custom-property-a :convention :stdcall) :uint32
  (dn-dev-inst :uint32)   ; DWORD
  (psz-custom-property-name :string)   ; LPCSTR
  (pul-reg-data-type :pointer)   ; DWORD* optional, out
  (buffer :pointer)   ; void* optional, out
  (pul-length :pointer)   ; DWORD* in/out
  (ul-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Get_DevNode_Custom_PropertyA = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Get_DevNode_Custom_PropertyA(DWORD dnDevInst, LPCSTR pszCustomPropertyName, LPVOID pulRegDataType, LPVOID Buffer, LPVOID pulLength, DWORD ulFlags)');
# my $ret = $CM_Get_DevNode_Custom_PropertyA->Call($dnDevInst, $pszCustomPropertyName, $pulRegDataType, $Buffer, $pulLength, $ulFlags);
# dnDevInst : DWORD -> DWORD
# pszCustomPropertyName : LPCSTR -> LPCSTR
# pulRegDataType : DWORD* optional, out -> LPVOID
# Buffer : void* optional, out -> LPVOID
# pulLength : DWORD* in/out -> LPVOID
# ulFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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