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

CM_Locate_DevNodeA

関数
指定デバイスIDのデバイスノードを検索して取得する。
DLLCFGMGR32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

CONFIGRET CM_Locate_DevNodeA(
    DWORD* pdnDevInst,
    LPSTR pDeviceID,   // optional
    CM_LOCATE_DEVNODE_FLAGS ulFlags
);

パラメーター

名前方向説明
pdnDevInstDWORD*out検出したデバイスノードのデバイスインスタンスハンドルを受け取る出力先。
pDeviceIDLPSTRinoptional検索対象のデバイスインスタンスID文字列(ANSI)。NULLの場合はルートデバイスを返す。
ulFlagsCM_LOCATE_DEVNODE_FLAGSin検出動作を制御するCM_LOCATE_DEVNODE_FLAGS。NORMAL/PHANTOM/CANCELREMOVE/REMOVED等を指定する。

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Locate_DevNodeA(
    DWORD* pdnDevInst,
    LPSTR pDeviceID,   // optional
    CM_LOCATE_DEVNODE_FLAGS ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CM_Locate_DevNodeA(
    out uint pdnDevInst,   // DWORD* out
    [MarshalAs(UnmanagedType.LPStr)] string pDeviceID,   // LPSTR optional
    uint ulFlags   // CM_LOCATE_DEVNODE_FLAGS
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CM_Locate_DevNodeA(
    <Out> ByRef pdnDevInst As UInteger,   ' DWORD* out
    <MarshalAs(UnmanagedType.LPStr)> pDeviceID As String,   ' LPSTR optional
    ulFlags As UInteger   ' CM_LOCATE_DEVNODE_FLAGS
) As UInteger
End Function
' pdnDevInst : DWORD* out
' pDeviceID : LPSTR optional
' ulFlags : CM_LOCATE_DEVNODE_FLAGS
Declare PtrSafe Function CM_Locate_DevNodeA Lib "cfgmgr32" ( _
    ByRef pdnDevInst As Long, _
    ByVal pDeviceID As String, _
    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_Locate_DevNodeA = ctypes.windll.cfgmgr32.CM_Locate_DevNodeA
CM_Locate_DevNodeA.restype = wintypes.DWORD
CM_Locate_DevNodeA.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pdnDevInst : DWORD* out
    wintypes.LPCSTR,  # pDeviceID : LPSTR optional
    wintypes.DWORD,  # ulFlags : CM_LOCATE_DEVNODE_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Locate_DevNodeA = cfgmgr32.NewProc("CM_Locate_DevNodeA")
)

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

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

typedef CM_Locate_DevNodeANative = Uint32 Function(Pointer<Uint32>, Pointer<Utf8>, Uint32);
typedef CM_Locate_DevNodeADart = int Function(Pointer<Uint32>, Pointer<Utf8>, int);
final CM_Locate_DevNodeA = DynamicLibrary.open('CFGMGR32.dll')
    .lookupFunction<CM_Locate_DevNodeANative, CM_Locate_DevNodeADart>('CM_Locate_DevNodeA');
// pdnDevInst : DWORD* out -> Pointer<Uint32>
// pDeviceID : LPSTR optional -> Pointer<Utf8>
// ulFlags : CM_LOCATE_DEVNODE_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CM_Locate_DevNodeA(
  pdnDevInst: Pointer;   // DWORD* out
  pDeviceID: PAnsiChar;   // LPSTR optional
  ulFlags: DWORD   // CM_LOCATE_DEVNODE_FLAGS
): DWORD; stdcall;
  external 'CFGMGR32.dll' name 'CM_Locate_DevNodeA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CM_Locate_DevNodeA"
  c_CM_Locate_DevNodeA :: Ptr Word32 -> CString -> Word32 -> IO Word32
-- pdnDevInst : DWORD* out -> Ptr Word32
-- pDeviceID : LPSTR optional -> CString
-- ulFlags : CM_LOCATE_DEVNODE_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_locate_devnodea =
  foreign "CM_Locate_DevNodeA"
    ((ptr uint32_t) @-> string @-> uint32_t @-> returning uint32_t)
(* pdnDevInst : DWORD* out -> (ptr uint32_t) *)
(* pDeviceID : LPSTR optional -> string *)
(* ulFlags : CM_LOCATE_DEVNODE_FLAGS -> 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_Locate_DevNodeA" cm-locate-dev-node-a :convention :stdcall) :uint32
  (pdn-dev-inst :pointer)   ; DWORD* out
  (p-device-id :string)   ; LPSTR optional
  (ul-flags :uint32))   ; CM_LOCATE_DEVNODE_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Locate_DevNodeA = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Locate_DevNodeA(LPVOID pdnDevInst, LPCSTR pDeviceID, DWORD ulFlags)');
# my $ret = $CM_Locate_DevNodeA->Call($pdnDevInst, $pDeviceID, $ulFlags);
# pdnDevInst : DWORD* out -> LPVOID
# pDeviceID : LPSTR optional -> LPCSTR
# ulFlags : CM_LOCATE_DEVNODE_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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