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

MprSetupProtocolEnum

関数
指定トランスポートで利用可能なルーティングプロトコルを列挙する。
DLLrtutils.dll呼出規約winapi

シグネチャ

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

DWORD MprSetupProtocolEnum(
    DWORD dwTransportId,
    BYTE** lplpBuffer,
    DWORD* lpdwEntriesRead
);

パラメーター

名前方向説明
dwTransportIdDWORDin列挙対象のトランスポートID(プロトコルファミリ)を指定する。
lplpBufferBYTE**inout列挙されたプロトコル情報バッファへのポインターを受け取る。使用後MprSetupProtocolFreeで解放する。
lpdwEntriesReadDWORD*inout読み込まれたプロトコルエントリ数を受け取る出力ポインター。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

MprSetupProtocolEnum = ctypes.windll.rtutils.MprSetupProtocolEnum
MprSetupProtocolEnum.restype = wintypes.DWORD
MprSetupProtocolEnum.argtypes = [
    wintypes.DWORD,  # dwTransportId : DWORD
    ctypes.c_void_p,  # lplpBuffer : BYTE** in/out
    ctypes.POINTER(wintypes.DWORD),  # lpdwEntriesRead : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtutils = windows.NewLazySystemDLL("rtutils.dll")
	procMprSetupProtocolEnum = rtutils.NewProc("MprSetupProtocolEnum")
)

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

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

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

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

(cffi:defcfun ("MprSetupProtocolEnum" mpr-setup-protocol-enum :convention :stdcall) :uint32
  (dw-transport-id :uint32)   ; DWORD
  (lplp-buffer :pointer)   ; BYTE** in/out
  (lpdw-entries-read :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprSetupProtocolEnum = Win32::API::More->new('rtutils',
    'DWORD MprSetupProtocolEnum(DWORD dwTransportId, LPVOID lplpBuffer, LPVOID lpdwEntriesRead)');
# my $ret = $MprSetupProtocolEnum->Call($dwTransportId, $lplpBuffer, $lpdwEntriesRead);
# dwTransportId : DWORD -> DWORD
# lplpBuffer : BYTE** in/out -> LPVOID
# lpdwEntriesRead : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。