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

MprAdminInterfaceGetHandle

関数
指定名のルーターインターフェイスのハンドルを取得する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD MprAdminInterfaceGetHandle(
    INT_PTR hMprServer,
    LPWSTR lpwsInterfaceName,
    HANDLE* phInterface,
    BOOL fIncludeClientInterfaces
);

パラメーター

名前方向説明
hMprServerINT_PTRinMprAdminServerConnectで取得したMPRサーバーハンドル(INT_PTR)。
lpwsInterfaceNameLPWSTRinハンドルを取得する対象インターフェイス名の文字列。
phInterfaceHANDLE*out取得したインターフェイスハンドルを受け取る変数へのポインタ。
fIncludeClientInterfacesBOOLinTRUEでクライアント(ダイヤルイン)インターフェイスも検索対象に含める真偽値。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MprAdminInterfaceGetHandle(
    INT_PTR hMprServer,
    LPWSTR lpwsInterfaceName,
    HANDLE* phInterface,
    BOOL fIncludeClientInterfaces
);
[DllImport("MPRAPI.dll", ExactSpelling = true)]
static extern uint MprAdminInterfaceGetHandle(
    IntPtr hMprServer,   // INT_PTR
    [MarshalAs(UnmanagedType.LPWStr)] string lpwsInterfaceName,   // LPWSTR
    IntPtr phInterface,   // HANDLE* out
    bool fIncludeClientInterfaces   // BOOL
);
<DllImport("MPRAPI.dll", ExactSpelling:=True)>
Public Shared Function MprAdminInterfaceGetHandle(
    hMprServer As IntPtr,   ' INT_PTR
    <MarshalAs(UnmanagedType.LPWStr)> lpwsInterfaceName As String,   ' LPWSTR
    phInterface As IntPtr,   ' HANDLE* out
    fIncludeClientInterfaces As Boolean   ' BOOL
) As UInteger
End Function
' hMprServer : INT_PTR
' lpwsInterfaceName : LPWSTR
' phInterface : HANDLE* out
' fIncludeClientInterfaces : BOOL
Declare PtrSafe Function MprAdminInterfaceGetHandle Lib "mprapi" ( _
    ByVal hMprServer As LongPtr, _
    ByVal lpwsInterfaceName As LongPtr, _
    ByVal phInterface As LongPtr, _
    ByVal fIncludeClientInterfaces As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MprAdminInterfaceGetHandle = ctypes.windll.mprapi.MprAdminInterfaceGetHandle
MprAdminInterfaceGetHandle.restype = wintypes.DWORD
MprAdminInterfaceGetHandle.argtypes = [
    ctypes.c_ssize_t,  # hMprServer : INT_PTR
    wintypes.LPCWSTR,  # lpwsInterfaceName : LPWSTR
    ctypes.c_void_p,  # phInterface : HANDLE* out
    wintypes.BOOL,  # fIncludeClientInterfaces : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MPRAPI.dll')
MprAdminInterfaceGetHandle = Fiddle::Function.new(
  lib['MprAdminInterfaceGetHandle'],
  [
    Fiddle::TYPE_INTPTR_T,  # hMprServer : INT_PTR
    Fiddle::TYPE_VOIDP,  # lpwsInterfaceName : LPWSTR
    Fiddle::TYPE_VOIDP,  # phInterface : HANDLE* out
    Fiddle::TYPE_INT,  # fIncludeClientInterfaces : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "mprapi")]
extern "system" {
    fn MprAdminInterfaceGetHandle(
        hMprServer: isize,  // INT_PTR
        lpwsInterfaceName: *mut u16,  // LPWSTR
        phInterface: *mut *mut core::ffi::c_void,  // HANDLE* out
        fIncludeClientInterfaces: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MPRAPI.dll")]
public static extern uint MprAdminInterfaceGetHandle(IntPtr hMprServer, [MarshalAs(UnmanagedType.LPWStr)] string lpwsInterfaceName, IntPtr phInterface, bool fIncludeClientInterfaces);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MPRAPI_MprAdminInterfaceGetHandle' -Namespace Win32 -PassThru
# $api::MprAdminInterfaceGetHandle(hMprServer, lpwsInterfaceName, phInterface, fIncludeClientInterfaces)
#uselib "MPRAPI.dll"
#func global MprAdminInterfaceGetHandle "MprAdminInterfaceGetHandle" sptr, sptr, sptr, sptr
; MprAdminInterfaceGetHandle hMprServer, lpwsInterfaceName, phInterface, fIncludeClientInterfaces   ; 戻り値は stat
; hMprServer : INT_PTR -> "sptr"
; lpwsInterfaceName : LPWSTR -> "sptr"
; phInterface : HANDLE* out -> "sptr"
; fIncludeClientInterfaces : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceGetHandle "MprAdminInterfaceGetHandle" sptr, wstr, sptr, int
; res = MprAdminInterfaceGetHandle(hMprServer, lpwsInterfaceName, phInterface, fIncludeClientInterfaces)
; hMprServer : INT_PTR -> "sptr"
; lpwsInterfaceName : LPWSTR -> "wstr"
; phInterface : HANDLE* out -> "sptr"
; fIncludeClientInterfaces : BOOL -> "int"
; DWORD MprAdminInterfaceGetHandle(INT_PTR hMprServer, LPWSTR lpwsInterfaceName, HANDLE* phInterface, BOOL fIncludeClientInterfaces)
#uselib "MPRAPI.dll"
#cfunc global MprAdminInterfaceGetHandle "MprAdminInterfaceGetHandle" intptr, wstr, intptr, int
; res = MprAdminInterfaceGetHandle(hMprServer, lpwsInterfaceName, phInterface, fIncludeClientInterfaces)
; hMprServer : INT_PTR -> "intptr"
; lpwsInterfaceName : LPWSTR -> "wstr"
; phInterface : HANDLE* out -> "intptr"
; fIncludeClientInterfaces : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminInterfaceGetHandle = mprapi.NewProc("MprAdminInterfaceGetHandle")
)

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

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

typedef MprAdminInterfaceGetHandleNative = Uint32 Function(IntPtr, Pointer<Utf16>, Pointer<Void>, Int32);
typedef MprAdminInterfaceGetHandleDart = int Function(int, Pointer<Utf16>, Pointer<Void>, int);
final MprAdminInterfaceGetHandle = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminInterfaceGetHandleNative, MprAdminInterfaceGetHandleDart>('MprAdminInterfaceGetHandle');
// hMprServer : INT_PTR -> IntPtr
// lpwsInterfaceName : LPWSTR -> Pointer<Utf16>
// phInterface : HANDLE* out -> Pointer<Void>
// fIncludeClientInterfaces : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminInterfaceGetHandle(
  hMprServer: NativeInt;   // INT_PTR
  lpwsInterfaceName: PWideChar;   // LPWSTR
  phInterface: Pointer;   // HANDLE* out
  fIncludeClientInterfaces: BOOL   // BOOL
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminInterfaceGetHandle';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminInterfaceGetHandle"
  c_MprAdminInterfaceGetHandle :: CIntPtr -> CWString -> Ptr () -> CInt -> IO Word32
-- hMprServer : INT_PTR -> CIntPtr
-- lpwsInterfaceName : LPWSTR -> CWString
-- phInterface : HANDLE* out -> Ptr ()
-- fIncludeClientInterfaces : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradmininterfacegethandle =
  foreign "MprAdminInterfaceGetHandle"
    (intptr_t @-> (ptr uint16_t) @-> (ptr void) @-> int32_t @-> returning uint32_t)
(* hMprServer : INT_PTR -> intptr_t *)
(* lpwsInterfaceName : LPWSTR -> (ptr uint16_t) *)
(* phInterface : HANDLE* out -> (ptr void) *)
(* fIncludeClientInterfaces : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminInterfaceGetHandle" mpr-admin-interface-get-handle :convention :stdcall) :uint32
  (h-mpr-server :int64)   ; INT_PTR
  (lpws-interface-name (:string :encoding :utf-16le))   ; LPWSTR
  (ph-interface :pointer)   ; HANDLE* out
  (f-include-client-interfaces :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminInterfaceGetHandle = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminInterfaceGetHandle(LPARAM hMprServer, LPCWSTR lpwsInterfaceName, HANDLE phInterface, BOOL fIncludeClientInterfaces)');
# my $ret = $MprAdminInterfaceGetHandle->Call($hMprServer, $lpwsInterfaceName, $phInterface, $fIncludeClientInterfaces);
# hMprServer : INT_PTR -> LPARAM
# lpwsInterfaceName : LPWSTR -> LPCWSTR
# phInterface : HANDLE* out -> HANDLE
# fIncludeClientInterfaces : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。