Win32 API 日本語リファレンス
ホームNetworkManagement.Rras › MprAdminDeviceEnum

MprAdminDeviceEnum

関数
ルーターサーバー上のデバイス一覧を列挙する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

// MPRAPI.dll
#include <windows.h>

DWORD MprAdminDeviceEnum(
    INT_PTR hMprServer,
    DWORD dwLevel,
    BYTE** lplpbBuffer,
    DWORD* lpdwTotalEntries
);

パラメーター

名前方向説明
hMprServerINT_PTRinMprAdminServerConnectで取得したMPRサーバーハンドル(INT_PTR)。
dwLevelDWORDin取得する情報レベル(現状は0)。返却構造体の種類を決める。
lplpbBufferBYTE**out確保されたデバイス情報バッファへのポインタを受け取る変数。MprAdminBufferFreeで解放する。
lpdwTotalEntriesDWORD*out列挙されたデバイスの総数を受け取る変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

// MPRAPI.dll
#include <windows.h>

DWORD MprAdminDeviceEnum(
    INT_PTR hMprServer,
    DWORD dwLevel,
    BYTE** lplpbBuffer,
    DWORD* lpdwTotalEntries
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprAdminDeviceEnum(
    IntPtr hMprServer,   // INT_PTR
    uint dwLevel,   // DWORD
    IntPtr lplpbBuffer,   // BYTE** out
    out uint lpdwTotalEntries   // DWORD* out
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprAdminDeviceEnum(
    hMprServer As IntPtr,   ' INT_PTR
    dwLevel As UInteger,   ' DWORD
    lplpbBuffer As IntPtr,   ' BYTE** out
    <Out> ByRef lpdwTotalEntries As UInteger   ' DWORD* out
) As UInteger
End Function
' hMprServer : INT_PTR
' dwLevel : DWORD
' lplpbBuffer : BYTE** out
' lpdwTotalEntries : DWORD* out
Declare PtrSafe Function MprAdminDeviceEnum Lib "mprapi" ( _
    ByVal hMprServer As LongPtr, _
    ByVal dwLevel As Long, _
    ByVal lplpbBuffer As LongPtr, _
    ByRef lpdwTotalEntries As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MprAdminDeviceEnum = ctypes.windll.mprapi.MprAdminDeviceEnum
MprAdminDeviceEnum.restype = wintypes.DWORD
MprAdminDeviceEnum.argtypes = [
    ctypes.c_ssize_t,  # hMprServer : INT_PTR
    wintypes.DWORD,  # dwLevel : DWORD
    ctypes.c_void_p,  # lplpbBuffer : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # lpdwTotalEntries : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprAdminDeviceEnum = Fiddle::Function.new(
  lib['MprAdminDeviceEnum'],
  [
    Fiddle::TYPE_INTPTR_T,  # hMprServer : INT_PTR
    -Fiddle::TYPE_INT,  # dwLevel : DWORD
    Fiddle::TYPE_VOIDP,  # lplpbBuffer : BYTE** out
    Fiddle::TYPE_VOIDP,  # lpdwTotalEntries : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprAdminDeviceEnum(
        hMprServer: isize,  // INT_PTR
        dwLevel: u32,  // DWORD
        lplpbBuffer: *mut *mut u8,  // BYTE** out
        lpdwTotalEntries: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPRAPI.dll")]
public static extern uint MprAdminDeviceEnum(IntPtr hMprServer, uint dwLevel, IntPtr lplpbBuffer, out uint lpdwTotalEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprAdminDeviceEnum' -Namespace Win32 -PassThru
# $api::MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
#uselib "MPRAPI.dll"
#func global MprAdminDeviceEnum "MprAdminDeviceEnum" sptr, sptr, sptr, sptr
; MprAdminDeviceEnum hMprServer, dwLevel, varptr(lplpbBuffer), varptr(lpdwTotalEntries)   ; 戻り値は stat
; hMprServer : INT_PTR -> "sptr"
; dwLevel : DWORD -> "sptr"
; lplpbBuffer : BYTE** out -> "sptr"
; lpdwTotalEntries : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MPRAPI.dll"
#cfunc global MprAdminDeviceEnum "MprAdminDeviceEnum" sptr, int, var, var
; res = MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
; hMprServer : INT_PTR -> "sptr"
; dwLevel : DWORD -> "int"
; lplpbBuffer : BYTE** out -> "var"
; lpdwTotalEntries : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MprAdminDeviceEnum(INT_PTR hMprServer, DWORD dwLevel, BYTE** lplpbBuffer, DWORD* lpdwTotalEntries)
#uselib "MPRAPI.dll"
#cfunc global MprAdminDeviceEnum "MprAdminDeviceEnum" intptr, int, var, var
; res = MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
; hMprServer : INT_PTR -> "intptr"
; dwLevel : DWORD -> "int"
; lplpbBuffer : BYTE** out -> "var"
; lpdwTotalEntries : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminDeviceEnum = mprapi.NewProc("MprAdminDeviceEnum")
)

// hMprServer (INT_PTR), dwLevel (DWORD), lplpbBuffer (BYTE** out), lpdwTotalEntries (DWORD* out)
r1, _, err := procMprAdminDeviceEnum.Call(
	uintptr(hMprServer),
	uintptr(dwLevel),
	uintptr(lplpbBuffer),
	uintptr(lpdwTotalEntries),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MprAdminDeviceEnum(
  hMprServer: NativeInt;   // INT_PTR
  dwLevel: DWORD;   // DWORD
  lplpbBuffer: Pointer;   // BYTE** out
  lpdwTotalEntries: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminDeviceEnum';
result := DllCall("MPRAPI\MprAdminDeviceEnum"
    , "Ptr", hMprServer   ; INT_PTR
    , "UInt", dwLevel   ; DWORD
    , "Ptr", lplpbBuffer   ; BYTE** out
    , "Ptr", lpdwTotalEntries   ; DWORD* out
    , "UInt")   ; return: DWORD
●MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries) = DLL("MPRAPI.dll", "dword MprAdminDeviceEnum(int, dword, void*, void*)")
# 呼び出し: MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
# hMprServer : INT_PTR -> "int"
# dwLevel : DWORD -> "dword"
# lplpbBuffer : BYTE** out -> "void*"
# lpdwTotalEntries : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "mprapi" fn MprAdminDeviceEnum(
    hMprServer: isize, // INT_PTR
    dwLevel: u32, // DWORD
    lplpbBuffer: [*c][*c]u8, // BYTE** out
    lpdwTotalEntries: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) u32;
proc MprAdminDeviceEnum(
    hMprServer: int,  # INT_PTR
    dwLevel: uint32,  # DWORD
    lplpbBuffer: ptr uint8,  # BYTE** out
    lpdwTotalEntries: ptr uint32  # DWORD* out
): uint32 {.importc: "MprAdminDeviceEnum", stdcall, dynlib: "MPRAPI.dll".}
pragma(lib, "mprapi");
extern(Windows)
uint MprAdminDeviceEnum(
    ptrdiff_t hMprServer,   // INT_PTR
    uint dwLevel,   // DWORD
    ubyte** lplpbBuffer,   // BYTE** out
    uint* lpdwTotalEntries   // DWORD* out
);
ccall((:MprAdminDeviceEnum, "MPRAPI.dll"), stdcall, UInt32,
      (Int, UInt32, Ptr{UInt8}, Ptr{UInt32}),
      hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
# hMprServer : INT_PTR -> Int
# dwLevel : DWORD -> UInt32
# lplpbBuffer : BYTE** out -> Ptr{UInt8}
# lpdwTotalEntries : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MprAdminDeviceEnum(
    intptr_t hMprServer,
    uint32_t dwLevel,
    uint8_t** lplpbBuffer,
    uint32_t* lpdwTotalEntries);
]]
local mprapi = ffi.load("mprapi")
-- mprapi.MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
-- hMprServer : INT_PTR
-- dwLevel : DWORD
-- lplpbBuffer : BYTE** out
-- lpdwTotalEntries : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('MPRAPI.dll');
const MprAdminDeviceEnum = lib.func('__stdcall', 'MprAdminDeviceEnum', 'uint32_t', ['intptr_t', 'uint32_t', 'uint8_t *', 'uint32_t *']);
// MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
// hMprServer : INT_PTR -> 'intptr_t'
// dwLevel : DWORD -> 'uint32_t'
// lplpbBuffer : BYTE** out -> 'uint8_t *'
// lpdwTotalEntries : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("MPRAPI.dll", {
  MprAdminDeviceEnum: { parameters: ["isize", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries)
// hMprServer : INT_PTR -> "isize"
// dwLevel : DWORD -> "u32"
// lplpbBuffer : BYTE** out -> "pointer"
// lpdwTotalEntries : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MprAdminDeviceEnum(
    intptr_t hMprServer,
    uint32_t dwLevel,
    uint8_t** lplpbBuffer,
    uint32_t* lpdwTotalEntries);
C, "MPRAPI.dll");
// $ffi->MprAdminDeviceEnum(hMprServer, dwLevel, lplpbBuffer, lpdwTotalEntries);
// hMprServer : INT_PTR
// dwLevel : DWORD
// lplpbBuffer : BYTE** out
// lpdwTotalEntries : DWORD* out
// 構造体/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 Mprapi extends StdCallLibrary {
    Mprapi INSTANCE = Native.load("mprapi", Mprapi.class);
    int MprAdminDeviceEnum(
        long hMprServer,   // INT_PTR
        int dwLevel,   // DWORD
        Pointer lplpbBuffer,   // BYTE** out
        IntByReference lpdwTotalEntries   // DWORD* out
    );
}
@[Link("mprapi")]
lib LibMPRAPI
  fun MprAdminDeviceEnum = MprAdminDeviceEnum(
    hMprServer : LibC::SSizeT,   # INT_PTR
    dwLevel : UInt32,   # DWORD
    lplpbBuffer : UInt8**,   # BYTE** out
    lpdwTotalEntries : UInt32*   # DWORD* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MprAdminDeviceEnumNative = Uint32 Function(IntPtr, Uint32, Pointer<Uint8>, Pointer<Uint32>);
typedef MprAdminDeviceEnumDart = int Function(int, int, Pointer<Uint8>, Pointer<Uint32>);
final MprAdminDeviceEnum = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminDeviceEnumNative, MprAdminDeviceEnumDart>('MprAdminDeviceEnum');
// hMprServer : INT_PTR -> IntPtr
// dwLevel : DWORD -> Uint32
// lplpbBuffer : BYTE** out -> Pointer<Uint8>
// lpdwTotalEntries : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminDeviceEnum(
  hMprServer: NativeInt;   // INT_PTR
  dwLevel: DWORD;   // DWORD
  lplpbBuffer: Pointer;   // BYTE** out
  lpdwTotalEntries: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminDeviceEnum';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminDeviceEnum"
  c_MprAdminDeviceEnum :: CIntPtr -> Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- hMprServer : INT_PTR -> CIntPtr
-- dwLevel : DWORD -> Word32
-- lplpbBuffer : BYTE** out -> Ptr Word8
-- lpdwTotalEntries : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradmindeviceenum =
  foreign "MprAdminDeviceEnum"
    (intptr_t @-> uint32_t @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hMprServer : INT_PTR -> intptr_t *)
(* dwLevel : DWORD -> uint32_t *)
(* lplpbBuffer : BYTE** out -> (ptr uint8_t) *)
(* lpdwTotalEntries : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminDeviceEnum" mpr-admin-device-enum :convention :stdcall) :uint32
  (h-mpr-server :int64)   ; INT_PTR
  (dw-level :uint32)   ; DWORD
  (lplpb-buffer :pointer)   ; BYTE** out
  (lpdw-total-entries :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminDeviceEnum = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminDeviceEnum(LPARAM hMprServer, DWORD dwLevel, LPVOID lplpbBuffer, LPVOID lpdwTotalEntries)');
# my $ret = $MprAdminDeviceEnum->Call($hMprServer, $dwLevel, $lplpbBuffer, $lpdwTotalEntries);
# hMprServer : INT_PTR -> LPARAM
# dwLevel : DWORD -> DWORD
# lplpbBuffer : BYTE** out -> LPVOID
# lpdwTotalEntries : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。