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

CM_Query_And_Remove_SubTreeA

関数
デバイスサブツリーを照会し可能なら削除する。
DLLCFGMGR32.dll文字セットANSI (-A)呼出規約winapi

シグネチャ

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

CONFIGRET CM_Query_And_Remove_SubTreeA(
    DWORD dnAncestor,
    PNP_VETO_TYPE* pVetoType,   // optional
    LPSTR pszVetoName,   // optional
    DWORD ulNameLength,
    DWORD ulFlags
);

パラメーター

名前方向説明
dnAncestorDWORDin問い合わせと削除を行うサブツリーの最上位(祖先)デバイスノードのハンドル。
pVetoTypePNP_VETO_TYPE*outoptional削除が拒否された場合に拒否元の種別(PNP_VETO_TYPE)を受け取る出力先。NULL可。
pszVetoNameLPSTRoutoptional拒否元の名前文字列(ANSI)を受け取る出力バッファ。NULL可。
ulNameLengthDWORDinpszVetoNameバッファの文字数。
ulFlagsDWORDin削除動作を制御するフラグ(CM_REMOVE_UI_OK/NO_UI/BITS等)。

戻り値の型: CONFIGRET

各言語での呼び出し定義

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

CONFIGRET CM_Query_And_Remove_SubTreeA(
    DWORD dnAncestor,
    PNP_VETO_TYPE* pVetoType,   // optional
    LPSTR pszVetoName,   // optional
    DWORD ulNameLength,
    DWORD ulFlags
);
[DllImport("CFGMGR32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint CM_Query_And_Remove_SubTreeA(
    uint dnAncestor,   // DWORD
    IntPtr pVetoType,   // PNP_VETO_TYPE* optional, out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszVetoName,   // LPSTR optional, out
    uint ulNameLength,   // DWORD
    uint ulFlags   // DWORD
);
<DllImport("CFGMGR32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function CM_Query_And_Remove_SubTreeA(
    dnAncestor As UInteger,   ' DWORD
    pVetoType As IntPtr,   ' PNP_VETO_TYPE* optional, out
    <MarshalAs(UnmanagedType.LPStr)> pszVetoName As System.Text.StringBuilder,   ' LPSTR optional, out
    ulNameLength As UInteger,   ' DWORD
    ulFlags As UInteger   ' DWORD
) As UInteger
End Function
' dnAncestor : DWORD
' pVetoType : PNP_VETO_TYPE* optional, out
' pszVetoName : LPSTR optional, out
' ulNameLength : DWORD
' ulFlags : DWORD
Declare PtrSafe Function CM_Query_And_Remove_SubTreeA Lib "cfgmgr32" ( _
    ByVal dnAncestor As Long, _
    ByVal pVetoType As LongPtr, _
    ByVal pszVetoName As String, _
    ByVal ulNameLength 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_Query_And_Remove_SubTreeA = ctypes.windll.cfgmgr32.CM_Query_And_Remove_SubTreeA
CM_Query_And_Remove_SubTreeA.restype = wintypes.DWORD
CM_Query_And_Remove_SubTreeA.argtypes = [
    wintypes.DWORD,  # dnAncestor : DWORD
    ctypes.c_void_p,  # pVetoType : PNP_VETO_TYPE* optional, out
    wintypes.LPSTR,  # pszVetoName : LPSTR optional, out
    wintypes.DWORD,  # ulNameLength : DWORD
    wintypes.DWORD,  # ulFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('CFGMGR32.dll')
CM_Query_And_Remove_SubTreeA = Fiddle::Function.new(
  lib['CM_Query_And_Remove_SubTreeA'],
  [
    -Fiddle::TYPE_INT,  # dnAncestor : DWORD
    Fiddle::TYPE_VOIDP,  # pVetoType : PNP_VETO_TYPE* optional, out
    Fiddle::TYPE_VOIDP,  # pszVetoName : LPSTR optional, out
    -Fiddle::TYPE_INT,  # ulNameLength : DWORD
    -Fiddle::TYPE_INT,  # ulFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "cfgmgr32")]
extern "system" {
    fn CM_Query_And_Remove_SubTreeA(
        dnAncestor: u32,  // DWORD
        pVetoType: *mut i32,  // PNP_VETO_TYPE* optional, out
        pszVetoName: *mut u8,  // LPSTR optional, out
        ulNameLength: u32,  // DWORD
        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_Query_And_Remove_SubTreeA(uint dnAncestor, IntPtr pVetoType, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszVetoName, uint ulNameLength, uint ulFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'CFGMGR32_CM_Query_And_Remove_SubTreeA' -Namespace Win32 -PassThru
# $api::CM_Query_And_Remove_SubTreeA(dnAncestor, pVetoType, pszVetoName, ulNameLength, ulFlags)
#uselib "CFGMGR32.dll"
#func global CM_Query_And_Remove_SubTreeA "CM_Query_And_Remove_SubTreeA" sptr, sptr, sptr, sptr, sptr
; CM_Query_And_Remove_SubTreeA dnAncestor, varptr(pVetoType), varptr(pszVetoName), ulNameLength, ulFlags   ; 戻り値は stat
; dnAncestor : DWORD -> "sptr"
; pVetoType : PNP_VETO_TYPE* optional, out -> "sptr"
; pszVetoName : LPSTR optional, out -> "sptr"
; ulNameLength : DWORD -> "sptr"
; ulFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "CFGMGR32.dll"
#cfunc global CM_Query_And_Remove_SubTreeA "CM_Query_And_Remove_SubTreeA" int, var, var, int, int
; res = CM_Query_And_Remove_SubTreeA(dnAncestor, pVetoType, pszVetoName, ulNameLength, ulFlags)
; dnAncestor : DWORD -> "int"
; pVetoType : PNP_VETO_TYPE* optional, out -> "var"
; pszVetoName : LPSTR optional, out -> "var"
; ulNameLength : DWORD -> "int"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; CONFIGRET CM_Query_And_Remove_SubTreeA(DWORD dnAncestor, PNP_VETO_TYPE* pVetoType, LPSTR pszVetoName, DWORD ulNameLength, DWORD ulFlags)
#uselib "CFGMGR32.dll"
#cfunc global CM_Query_And_Remove_SubTreeA "CM_Query_And_Remove_SubTreeA" int, var, var, int, int
; res = CM_Query_And_Remove_SubTreeA(dnAncestor, pVetoType, pszVetoName, ulNameLength, ulFlags)
; dnAncestor : DWORD -> "int"
; pVetoType : PNP_VETO_TYPE* optional, out -> "var"
; pszVetoName : LPSTR optional, out -> "var"
; ulNameLength : DWORD -> "int"
; ulFlags : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	cfgmgr32 = windows.NewLazySystemDLL("CFGMGR32.dll")
	procCM_Query_And_Remove_SubTreeA = cfgmgr32.NewProc("CM_Query_And_Remove_SubTreeA")
)

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

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

foreign import stdcall safe "CM_Query_And_Remove_SubTreeA"
  c_CM_Query_And_Remove_SubTreeA :: Word32 -> Ptr Int32 -> CString -> Word32 -> Word32 -> IO Word32
-- dnAncestor : DWORD -> Word32
-- pVetoType : PNP_VETO_TYPE* optional, out -> Ptr Int32
-- pszVetoName : LPSTR optional, out -> CString
-- ulNameLength : DWORD -> Word32
-- ulFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let cm_query_and_remove_subtreea =
  foreign "CM_Query_And_Remove_SubTreeA"
    (uint32_t @-> (ptr int32_t) @-> string @-> uint32_t @-> uint32_t @-> returning uint32_t)
(* dnAncestor : DWORD -> uint32_t *)
(* pVetoType : PNP_VETO_TYPE* optional, out -> (ptr int32_t) *)
(* pszVetoName : LPSTR optional, out -> string *)
(* ulNameLength : DWORD -> 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_Query_And_Remove_SubTreeA" cm-query-and-remove-sub-tree-a :convention :stdcall) :uint32
  (dn-ancestor :uint32)   ; DWORD
  (p-veto-type :pointer)   ; PNP_VETO_TYPE* optional, out
  (psz-veto-name :pointer)   ; LPSTR optional, out
  (ul-name-length :uint32)   ; DWORD
  (ul-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CM_Query_And_Remove_SubTreeA = Win32::API::More->new('CFGMGR32',
    'DWORD CM_Query_And_Remove_SubTreeA(DWORD dnAncestor, LPVOID pVetoType, LPSTR pszVetoName, DWORD ulNameLength, DWORD ulFlags)');
# my $ret = $CM_Query_And_Remove_SubTreeA->Call($dnAncestor, $pVetoType, $pszVetoName, $ulNameLength, $ulFlags);
# dnAncestor : DWORD -> DWORD
# pVetoType : PNP_VETO_TYPE* optional, out -> LPVOID
# pszVetoName : LPSTR optional, out -> LPSTR
# ulNameLength : DWORD -> DWORD
# ulFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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