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

MgmGetFirstMfe

関数
最初のマルチキャスト転送エントリMFEを取得する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MgmGetFirstMfe(
    DWORD* pdwBufferSize,
    BYTE* pbBuffer,
    DWORD* pdwNumEntries
);

パラメーター

名前方向説明
pdwBufferSizeDWORD*inout入力でpbBufferのサイズ、出力で必要/使用バイト数を返すポインタ。
pbBufferBYTE*inout最初のMFE群を受け取るバッファへのポインタ。
pdwNumEntriesDWORD*inoutバッファに返されたMFEエントリ数を受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MgmGetFirstMfe(
    DWORD* pdwBufferSize,
    BYTE* pbBuffer,
    DWORD* pdwNumEntries
);
[DllImport("rtm.dll", ExactSpelling = true)]
static extern uint MgmGetFirstMfe(
    ref uint pdwBufferSize,   // DWORD* in/out
    IntPtr pbBuffer,   // BYTE* in/out
    ref uint pdwNumEntries   // DWORD* in/out
);
<DllImport("rtm.dll", ExactSpelling:=True)>
Public Shared Function MgmGetFirstMfe(
    ByRef pdwBufferSize As UInteger,   ' DWORD* in/out
    pbBuffer As IntPtr,   ' BYTE* in/out
    ByRef pdwNumEntries As UInteger   ' DWORD* in/out
) As UInteger
End Function
' pdwBufferSize : DWORD* in/out
' pbBuffer : BYTE* in/out
' pdwNumEntries : DWORD* in/out
Declare PtrSafe Function MgmGetFirstMfe Lib "rtm" ( _
    ByRef pdwBufferSize As Long, _
    ByVal pbBuffer As LongPtr, _
    ByRef pdwNumEntries As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MgmGetFirstMfe = ctypes.windll.rtm.MgmGetFirstMfe
MgmGetFirstMfe.restype = wintypes.DWORD
MgmGetFirstMfe.argtypes = [
    ctypes.POINTER(wintypes.DWORD),  # pdwBufferSize : DWORD* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # pbBuffer : BYTE* in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwNumEntries : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procMgmGetFirstMfe = rtm.NewProc("MgmGetFirstMfe")
)

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

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

typedef MgmGetFirstMfeNative = Uint32 Function(Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
typedef MgmGetFirstMfeDart = int Function(Pointer<Uint32>, Pointer<Uint8>, Pointer<Uint32>);
final MgmGetFirstMfe = DynamicLibrary.open('rtm.dll')
    .lookupFunction<MgmGetFirstMfeNative, MgmGetFirstMfeDart>('MgmGetFirstMfe');
// pdwBufferSize : DWORD* in/out -> Pointer<Uint32>
// pbBuffer : BYTE* in/out -> Pointer<Uint8>
// pdwNumEntries : DWORD* in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MgmGetFirstMfe(
  pdwBufferSize: Pointer;   // DWORD* in/out
  pbBuffer: Pointer;   // BYTE* in/out
  pdwNumEntries: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'rtm.dll' name 'MgmGetFirstMfe';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MgmGetFirstMfe"
  c_MgmGetFirstMfe :: Ptr Word32 -> Ptr Word8 -> Ptr Word32 -> IO Word32
-- pdwBufferSize : DWORD* in/out -> Ptr Word32
-- pbBuffer : BYTE* in/out -> Ptr Word8
-- pdwNumEntries : DWORD* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mgmgetfirstmfe =
  foreign "MgmGetFirstMfe"
    ((ptr uint32_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* pdwBufferSize : DWORD* in/out -> (ptr uint32_t) *)
(* pbBuffer : BYTE* in/out -> (ptr uint8_t) *)
(* pdwNumEntries : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("MgmGetFirstMfe" mgm-get-first-mfe :convention :stdcall) :uint32
  (pdw-buffer-size :pointer)   ; DWORD* in/out
  (pb-buffer :pointer)   ; BYTE* in/out
  (pdw-num-entries :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MgmGetFirstMfe = Win32::API::More->new('rtm',
    'DWORD MgmGetFirstMfe(LPVOID pdwBufferSize, LPVOID pbBuffer, LPVOID pdwNumEntries)');
# my $ret = $MgmGetFirstMfe->Call($pdwBufferSize, $pbBuffer, $pdwNumEntries);
# pdwBufferSize : DWORD* in/out -> LPVOID
# pbBuffer : BYTE* in/out -> LPVOID
# pdwNumEntries : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。