ホーム › Devices.DeviceQuery › DevGetObjects

DevGetObjects

関数

条件に一致するデバイスオブジェクトを同期的に取得する。

DLLapi-ms-win-devices-query-l1-1-0.dll呼出規約winapi

シグネチャ

// api-ms-win-devices-query-l1-1-0.dll
#include <windows.h>

HRESULT DevGetObjects(
    DEV_OBJECT_TYPE ObjectType,
    DWORD QueryFlags,
    DWORD cRequestedProperties,
    const DEVPROPCOMPKEY* pRequestedProperties,   // optional
    DWORD cFilterExpressionCount,
    const DEVPROP_FILTER_EXPRESSION* pFilter,   // optional
    DWORD* pcObjectCount,
    const DEV_OBJECT** ppObjects
);

パラメーター

名前	型	方向
ObjectType	DEV_OBJECT_TYPE	in
QueryFlags	DWORD	in
cRequestedProperties	DWORD	in
pRequestedProperties	DEVPROPCOMPKEY*	inoptional
cFilterExpressionCount	DWORD	in
pFilter	DEVPROP_FILTER_EXPRESSION*	inoptional
pcObjectCount	DWORD*	out
ppObjects	DEV_OBJECT**	out

戻り値の型: HRESULT

各言語での呼び出し定義

// api-ms-win-devices-query-l1-1-0.dll
#include <windows.h>

HRESULT DevGetObjects(
    DEV_OBJECT_TYPE ObjectType,
    DWORD QueryFlags,
    DWORD cRequestedProperties,
    const DEVPROPCOMPKEY* pRequestedProperties,   // optional
    DWORD cFilterExpressionCount,
    const DEVPROP_FILTER_EXPRESSION* pFilter,   // optional
    DWORD* pcObjectCount,
    const DEV_OBJECT** ppObjects
);

[DllImport("api-ms-win-devices-query-l1-1-0.dll", ExactSpelling = true)]
static extern int DevGetObjects(
    int ObjectType,   // DEV_OBJECT_TYPE
    uint QueryFlags,   // DWORD
    uint cRequestedProperties,   // DWORD
    IntPtr pRequestedProperties,   // DEVPROPCOMPKEY* optional
    uint cFilterExpressionCount,   // DWORD
    IntPtr pFilter,   // DEVPROP_FILTER_EXPRESSION* optional
    out uint pcObjectCount,   // DWORD* out
    IntPtr ppObjects   // DEV_OBJECT** out
);

<DllImport("api-ms-win-devices-query-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function DevGetObjects(
    ObjectType As Integer,   ' DEV_OBJECT_TYPE
    QueryFlags As UInteger,   ' DWORD
    cRequestedProperties As UInteger,   ' DWORD
    pRequestedProperties As IntPtr,   ' DEVPROPCOMPKEY* optional
    cFilterExpressionCount As UInteger,   ' DWORD
    pFilter As IntPtr,   ' DEVPROP_FILTER_EXPRESSION* optional
    <Out> ByRef pcObjectCount As UInteger,   ' DWORD* out
    ppObjects As IntPtr   ' DEV_OBJECT** out
) As Integer
End Function

' ObjectType : DEV_OBJECT_TYPE
' QueryFlags : DWORD
' cRequestedProperties : DWORD
' pRequestedProperties : DEVPROPCOMPKEY* optional
' cFilterExpressionCount : DWORD
' pFilter : DEVPROP_FILTER_EXPRESSION* optional
' pcObjectCount : DWORD* out
' ppObjects : DEV_OBJECT** out
Declare PtrSafe Function DevGetObjects Lib "api-ms-win-devices-query-l1-1-0" ( _
    ByVal ObjectType As Long, _
    ByVal QueryFlags As Long, _
    ByVal cRequestedProperties As Long, _
    ByVal pRequestedProperties As LongPtr, _
    ByVal cFilterExpressionCount As Long, _
    ByVal pFilter As LongPtr, _
    ByRef pcObjectCount As Long, _
    ByVal ppObjects As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DevGetObjects = ctypes.windll.LoadLibrary("api-ms-win-devices-query-l1-1-0.dll").DevGetObjects
DevGetObjects.restype = ctypes.c_int
DevGetObjects.argtypes = [
    ctypes.c_int,  # ObjectType : DEV_OBJECT_TYPE
    wintypes.DWORD,  # QueryFlags : DWORD
    wintypes.DWORD,  # cRequestedProperties : DWORD
    ctypes.c_void_p,  # pRequestedProperties : DEVPROPCOMPKEY* optional
    wintypes.DWORD,  # cFilterExpressionCount : DWORD
    ctypes.c_void_p,  # pFilter : DEVPROP_FILTER_EXPRESSION* optional
    ctypes.POINTER(wintypes.DWORD),  # pcObjectCount : DWORD* out
    ctypes.c_void_p,  # ppObjects : DEV_OBJECT** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-devices-query-l1-1-0.dll')
DevGetObjects = Fiddle::Function.new(
  lib['DevGetObjects'],
  [
    Fiddle::TYPE_INT,  # ObjectType : DEV_OBJECT_TYPE
    -Fiddle::TYPE_INT,  # QueryFlags : DWORD
    -Fiddle::TYPE_INT,  # cRequestedProperties : DWORD
    Fiddle::TYPE_VOIDP,  # pRequestedProperties : DEVPROPCOMPKEY* optional
    -Fiddle::TYPE_INT,  # cFilterExpressionCount : DWORD
    Fiddle::TYPE_VOIDP,  # pFilter : DEVPROP_FILTER_EXPRESSION* optional
    Fiddle::TYPE_VOIDP,  # pcObjectCount : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppObjects : DEV_OBJECT** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-devices-query-l1-1-0")]
extern "system" {
    fn DevGetObjects(
        ObjectType: i32,  // DEV_OBJECT_TYPE
        QueryFlags: u32,  // DWORD
        cRequestedProperties: u32,  // DWORD
        pRequestedProperties: *const DEVPROPCOMPKEY,  // DEVPROPCOMPKEY* optional
        cFilterExpressionCount: u32,  // DWORD
        pFilter: *const DEVPROP_FILTER_EXPRESSION,  // DEVPROP_FILTER_EXPRESSION* optional
        pcObjectCount: *mut u32,  // DWORD* out
        ppObjects: *const *const DEV_OBJECT  // DEV_OBJECT** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("api-ms-win-devices-query-l1-1-0.dll")]
public static extern int DevGetObjects(int ObjectType, uint QueryFlags, uint cRequestedProperties, IntPtr pRequestedProperties, uint cFilterExpressionCount, IntPtr pFilter, out uint pcObjectCount, IntPtr ppObjects);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-devices-query-l1-1-0_DevGetObjects' -Namespace Win32 -PassThru
# $api::DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, pRequestedProperties, cFilterExpressionCount, pFilter, pcObjectCount, ppObjects)

#uselib "api-ms-win-devices-query-l1-1-0.dll"
#func global DevGetObjects "DevGetObjects" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DevGetObjects ObjectType, QueryFlags, cRequestedProperties, varptr(pRequestedProperties), cFilterExpressionCount, varptr(pFilter), varptr(pcObjectCount), varptr(ppObjects)   ; 戻り値は stat
; ObjectType : DEV_OBJECT_TYPE -> "sptr"
; QueryFlags : DWORD -> "sptr"
; cRequestedProperties : DWORD -> "sptr"
; pRequestedProperties : DEVPROPCOMPKEY* optional -> "sptr"
; cFilterExpressionCount : DWORD -> "sptr"
; pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "sptr"
; pcObjectCount : DWORD* out -> "sptr"
; ppObjects : DEV_OBJECT** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "api-ms-win-devices-query-l1-1-0.dll"
#cfunc global DevGetObjects "DevGetObjects" int, int, int, var, int, var, var, var
; res = DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, pRequestedProperties, cFilterExpressionCount, pFilter, pcObjectCount, ppObjects)
; ObjectType : DEV_OBJECT_TYPE -> "int"
; QueryFlags : DWORD -> "int"
; cRequestedProperties : DWORD -> "int"
; pRequestedProperties : DEVPROPCOMPKEY* optional -> "var"
; cFilterExpressionCount : DWORD -> "int"
; pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "var"
; pcObjectCount : DWORD* out -> "var"
; ppObjects : DEV_OBJECT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-devices-query-l1-1-0.dll"
#cfunc global DevGetObjects "DevGetObjects" int, int, int, sptr, int, sptr, sptr, sptr
; res = DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, varptr(pRequestedProperties), cFilterExpressionCount, varptr(pFilter), varptr(pcObjectCount), varptr(ppObjects))
; ObjectType : DEV_OBJECT_TYPE -> "int"
; QueryFlags : DWORD -> "int"
; cRequestedProperties : DWORD -> "int"
; pRequestedProperties : DEVPROPCOMPKEY* optional -> "sptr"
; cFilterExpressionCount : DWORD -> "int"
; pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "sptr"
; pcObjectCount : DWORD* out -> "sptr"
; ppObjects : DEV_OBJECT** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; HRESULT DevGetObjects(DEV_OBJECT_TYPE ObjectType, DWORD QueryFlags, DWORD cRequestedProperties, DEVPROPCOMPKEY* pRequestedProperties, DWORD cFilterExpressionCount, DEVPROP_FILTER_EXPRESSION* pFilter, DWORD* pcObjectCount, DEV_OBJECT** ppObjects)
#uselib "api-ms-win-devices-query-l1-1-0.dll"
#cfunc global DevGetObjects "DevGetObjects" int, int, int, var, int, var, var, var
; res = DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, pRequestedProperties, cFilterExpressionCount, pFilter, pcObjectCount, ppObjects)
; ObjectType : DEV_OBJECT_TYPE -> "int"
; QueryFlags : DWORD -> "int"
; cRequestedProperties : DWORD -> "int"
; pRequestedProperties : DEVPROPCOMPKEY* optional -> "var"
; cFilterExpressionCount : DWORD -> "int"
; pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "var"
; pcObjectCount : DWORD* out -> "var"
; ppObjects : DEV_OBJECT** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT DevGetObjects(DEV_OBJECT_TYPE ObjectType, DWORD QueryFlags, DWORD cRequestedProperties, DEVPROPCOMPKEY* pRequestedProperties, DWORD cFilterExpressionCount, DEVPROP_FILTER_EXPRESSION* pFilter, DWORD* pcObjectCount, DEV_OBJECT** ppObjects)
#uselib "api-ms-win-devices-query-l1-1-0.dll"
#cfunc global DevGetObjects "DevGetObjects" int, int, int, intptr, int, intptr, intptr, intptr
; res = DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, varptr(pRequestedProperties), cFilterExpressionCount, varptr(pFilter), varptr(pcObjectCount), varptr(ppObjects))
; ObjectType : DEV_OBJECT_TYPE -> "int"
; QueryFlags : DWORD -> "int"
; cRequestedProperties : DWORD -> "int"
; pRequestedProperties : DEVPROPCOMPKEY* optional -> "intptr"
; cFilterExpressionCount : DWORD -> "int"
; pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "intptr"
; pcObjectCount : DWORD* out -> "intptr"
; ppObjects : DEV_OBJECT** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_devices_query_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-devices-query-l1-1-0.dll")
	procDevGetObjects = api_ms_win_devices_query_l1_1_0.NewProc("DevGetObjects")
)

// ObjectType (DEV_OBJECT_TYPE), QueryFlags (DWORD), cRequestedProperties (DWORD), pRequestedProperties (DEVPROPCOMPKEY* optional), cFilterExpressionCount (DWORD), pFilter (DEVPROP_FILTER_EXPRESSION* optional), pcObjectCount (DWORD* out), ppObjects (DEV_OBJECT** out)
r1, _, err := procDevGetObjects.Call(
	uintptr(ObjectType),
	uintptr(QueryFlags),
	uintptr(cRequestedProperties),
	uintptr(pRequestedProperties),
	uintptr(cFilterExpressionCount),
	uintptr(pFilter),
	uintptr(pcObjectCount),
	uintptr(ppObjects),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT

function DevGetObjects(
  ObjectType: Integer;   // DEV_OBJECT_TYPE
  QueryFlags: DWORD;   // DWORD
  cRequestedProperties: DWORD;   // DWORD
  pRequestedProperties: Pointer;   // DEVPROPCOMPKEY* optional
  cFilterExpressionCount: DWORD;   // DWORD
  pFilter: Pointer;   // DEVPROP_FILTER_EXPRESSION* optional
  pcObjectCount: Pointer;   // DWORD* out
  ppObjects: Pointer   // DEV_OBJECT** out
): Integer; stdcall;
  external 'api-ms-win-devices-query-l1-1-0.dll' name 'DevGetObjects';

result := DllCall("api-ms-win-devices-query-l1-1-0\DevGetObjects"
    , "Int", ObjectType   ; DEV_OBJECT_TYPE
    , "UInt", QueryFlags   ; DWORD
    , "UInt", cRequestedProperties   ; DWORD
    , "Ptr", pRequestedProperties   ; DEVPROPCOMPKEY* optional
    , "UInt", cFilterExpressionCount   ; DWORD
    , "Ptr", pFilter   ; DEVPROP_FILTER_EXPRESSION* optional
    , "Ptr", pcObjectCount   ; DWORD* out
    , "Ptr", ppObjects   ; DEV_OBJECT** out
    , "Int")   ; return: HRESULT

●DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, pRequestedProperties, cFilterExpressionCount, pFilter, pcObjectCount, ppObjects) = DLL("api-ms-win-devices-query-l1-1-0.dll", "int DevGetObjects(int, dword, dword, void*, dword, void*, void*, void*)")
# 呼び出し: DevGetObjects(ObjectType, QueryFlags, cRequestedProperties, pRequestedProperties, cFilterExpressionCount, pFilter, pcObjectCount, ppObjects)
# ObjectType : DEV_OBJECT_TYPE -> "int"
# QueryFlags : DWORD -> "dword"
# cRequestedProperties : DWORD -> "dword"
# pRequestedProperties : DEVPROPCOMPKEY* optional -> "void*"
# cFilterExpressionCount : DWORD -> "dword"
# pFilter : DEVPROP_FILTER_EXPRESSION* optional -> "void*"
# pcObjectCount : DWORD* out -> "void*"
# ppObjects : DEV_OBJECT** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。