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

MgmGroupEnumerationStart

関数
マルチキャストグループ情報の列挙を開始する。
DLLrtm.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MgmGroupEnumerationStart(
    HANDLE hProtocol,
    MGM_ENUM_TYPES metEnumType,
    HANDLE* phEnumHandle
);

パラメーター

名前方向説明
hProtocolHANDLEinMgmRegisterMProtocolで取得したプロトコルハンドル。
metEnumTypeMGM_ENUM_TYPESin列挙する対象の種類を示すMGM_ENUM_TYPES列挙値。
phEnumHandleHANDLE*inout開始された列挙のハンドルを受け取るポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

MgmGroupEnumerationStart = ctypes.windll.rtm.MgmGroupEnumerationStart
MgmGroupEnumerationStart.restype = wintypes.DWORD
MgmGroupEnumerationStart.argtypes = [
    wintypes.HANDLE,  # hProtocol : HANDLE
    ctypes.c_int,  # metEnumType : MGM_ENUM_TYPES
    ctypes.c_void_p,  # phEnumHandle : HANDLE* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('rtm.dll')
MgmGroupEnumerationStart = Fiddle::Function.new(
  lib['MgmGroupEnumerationStart'],
  [
    Fiddle::TYPE_VOIDP,  # hProtocol : HANDLE
    Fiddle::TYPE_INT,  # metEnumType : MGM_ENUM_TYPES
    Fiddle::TYPE_VOIDP,  # phEnumHandle : HANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "rtm")]
extern "system" {
    fn MgmGroupEnumerationStart(
        hProtocol: *mut core::ffi::c_void,  // HANDLE
        metEnumType: i32,  // MGM_ENUM_TYPES
        phEnumHandle: *mut *mut core::ffi::c_void  // HANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("rtm.dll")]
public static extern uint MgmGroupEnumerationStart(IntPtr hProtocol, int metEnumType, IntPtr phEnumHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'rtm_MgmGroupEnumerationStart' -Namespace Win32 -PassThru
# $api::MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
#uselib "rtm.dll"
#func global MgmGroupEnumerationStart "MgmGroupEnumerationStart" sptr, sptr, sptr
; MgmGroupEnumerationStart hProtocol, metEnumType, phEnumHandle   ; 戻り値は stat
; hProtocol : HANDLE -> "sptr"
; metEnumType : MGM_ENUM_TYPES -> "sptr"
; phEnumHandle : HANDLE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "rtm.dll"
#cfunc global MgmGroupEnumerationStart "MgmGroupEnumerationStart" sptr, int, sptr
; res = MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
; hProtocol : HANDLE -> "sptr"
; metEnumType : MGM_ENUM_TYPES -> "int"
; phEnumHandle : HANDLE* in/out -> "sptr"
; DWORD MgmGroupEnumerationStart(HANDLE hProtocol, MGM_ENUM_TYPES metEnumType, HANDLE* phEnumHandle)
#uselib "rtm.dll"
#cfunc global MgmGroupEnumerationStart "MgmGroupEnumerationStart" intptr, int, intptr
; res = MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
; hProtocol : HANDLE -> "intptr"
; metEnumType : MGM_ENUM_TYPES -> "int"
; phEnumHandle : HANDLE* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtm = windows.NewLazySystemDLL("rtm.dll")
	procMgmGroupEnumerationStart = rtm.NewProc("MgmGroupEnumerationStart")
)

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

extern "rtm" fn MgmGroupEnumerationStart(
    hProtocol: ?*anyopaque, // HANDLE
    metEnumType: i32, // MGM_ENUM_TYPES
    phEnumHandle: ?*anyopaque // HANDLE* in/out
) callconv(std.os.windows.WINAPI) u32;
proc MgmGroupEnumerationStart(
    hProtocol: pointer,  # HANDLE
    metEnumType: int32,  # MGM_ENUM_TYPES
    phEnumHandle: pointer  # HANDLE* in/out
): uint32 {.importc: "MgmGroupEnumerationStart", stdcall, dynlib: "rtm.dll".}
pragma(lib, "rtm");
extern(Windows)
uint MgmGroupEnumerationStart(
    void* hProtocol,   // HANDLE
    int metEnumType,   // MGM_ENUM_TYPES
    void* phEnumHandle   // HANDLE* in/out
);
ccall((:MgmGroupEnumerationStart, "rtm.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}),
      hProtocol, metEnumType, phEnumHandle)
# hProtocol : HANDLE -> Ptr{Cvoid}
# metEnumType : MGM_ENUM_TYPES -> Int32
# phEnumHandle : HANDLE* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MgmGroupEnumerationStart(
    void* hProtocol,
    int32_t metEnumType,
    void* phEnumHandle);
]]
local rtm = ffi.load("rtm")
-- rtm.MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
-- hProtocol : HANDLE
-- metEnumType : MGM_ENUM_TYPES
-- phEnumHandle : HANDLE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('rtm.dll');
const MgmGroupEnumerationStart = lib.func('__stdcall', 'MgmGroupEnumerationStart', 'uint32_t', ['void *', 'int32_t', 'void *']);
// MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
// hProtocol : HANDLE -> 'void *'
// metEnumType : MGM_ENUM_TYPES -> 'int32_t'
// phEnumHandle : HANDLE* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("rtm.dll", {
  MgmGroupEnumerationStart: { parameters: ["pointer", "i32", "pointer"], result: "u32" },
});
// lib.symbols.MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle)
// hProtocol : HANDLE -> "pointer"
// metEnumType : MGM_ENUM_TYPES -> "i32"
// phEnumHandle : HANDLE* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MgmGroupEnumerationStart(
    void* hProtocol,
    int32_t metEnumType,
    void* phEnumHandle);
C, "rtm.dll");
// $ffi->MgmGroupEnumerationStart(hProtocol, metEnumType, phEnumHandle);
// hProtocol : HANDLE
// metEnumType : MGM_ENUM_TYPES
// phEnumHandle : HANDLE* 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 MgmGroupEnumerationStart(
        Pointer hProtocol,   // HANDLE
        int metEnumType,   // MGM_ENUM_TYPES
        Pointer phEnumHandle   // HANDLE* in/out
    );
}
@[Link("rtm")]
lib Librtm
  fun MgmGroupEnumerationStart = MgmGroupEnumerationStart(
    hProtocol : Void*,   # HANDLE
    metEnumType : Int32,   # MGM_ENUM_TYPES
    phEnumHandle : Void*   # HANDLE* 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 MgmGroupEnumerationStartNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Void>);
typedef MgmGroupEnumerationStartDart = int Function(Pointer<Void>, int, Pointer<Void>);
final MgmGroupEnumerationStart = DynamicLibrary.open('rtm.dll')
    .lookupFunction<MgmGroupEnumerationStartNative, MgmGroupEnumerationStartDart>('MgmGroupEnumerationStart');
// hProtocol : HANDLE -> Pointer<Void>
// metEnumType : MGM_ENUM_TYPES -> Int32
// phEnumHandle : HANDLE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MgmGroupEnumerationStart(
  hProtocol: THandle;   // HANDLE
  metEnumType: Integer;   // MGM_ENUM_TYPES
  phEnumHandle: Pointer   // HANDLE* in/out
): DWORD; stdcall;
  external 'rtm.dll' name 'MgmGroupEnumerationStart';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MgmGroupEnumerationStart"
  c_MgmGroupEnumerationStart :: Ptr () -> Int32 -> Ptr () -> IO Word32
-- hProtocol : HANDLE -> Ptr ()
-- metEnumType : MGM_ENUM_TYPES -> Int32
-- phEnumHandle : HANDLE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mgmgroupenumerationstart =
  foreign "MgmGroupEnumerationStart"
    ((ptr void) @-> int32_t @-> (ptr void) @-> returning uint32_t)
(* hProtocol : HANDLE -> (ptr void) *)
(* metEnumType : MGM_ENUM_TYPES -> int32_t *)
(* phEnumHandle : HANDLE* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtm (t "rtm.dll"))
(cffi:use-foreign-library rtm)

(cffi:defcfun ("MgmGroupEnumerationStart" mgm-group-enumeration-start :convention :stdcall) :uint32
  (h-protocol :pointer)   ; HANDLE
  (met-enum-type :int32)   ; MGM_ENUM_TYPES
  (ph-enum-handle :pointer))   ; HANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MgmGroupEnumerationStart = Win32::API::More->new('rtm',
    'DWORD MgmGroupEnumerationStart(HANDLE hProtocol, int metEnumType, HANDLE phEnumHandle)');
# my $ret = $MgmGroupEnumerationStart->Call($hProtocol, $metEnumType, $phEnumHandle);
# hProtocol : HANDLE -> HANDLE
# metEnumType : MGM_ENUM_TYPES -> int
# phEnumHandle : HANDLE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型