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

MprAdminInterfaceSetCustomInfoEx

関数
ルーターインターフェイスの拡張カスタム情報を設定する。
DLLMPRAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD MprAdminInterfaceSetCustomInfoEx(
    INT_PTR hMprServer,
    HANDLE hInterface,
    MPR_IF_CUSTOMINFOEX2* pCustomInfo
);

パラメーター

名前方向説明
hMprServerINT_PTRinMprAdminServerConnectで取得したMPRサーバーハンドル(INT_PTR)。
hInterfaceHANDLEin対象ルーターインターフェイスのハンドル。
pCustomInfoMPR_IF_CUSTOMINFOEX2*in設定するカスタム情報を格納したMPR_IF_CUSTOMINFOEX2構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

MprAdminInterfaceSetCustomInfoEx = ctypes.windll.mprapi.MprAdminInterfaceSetCustomInfoEx
MprAdminInterfaceSetCustomInfoEx.restype = wintypes.DWORD
MprAdminInterfaceSetCustomInfoEx.argtypes = [
    ctypes.c_ssize_t,  # hMprServer : INT_PTR
    wintypes.HANDLE,  # hInterface : HANDLE
    ctypes.c_void_p,  # pCustomInfo : MPR_IF_CUSTOMINFOEX2*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mprapi = windows.NewLazySystemDLL("MPRAPI.dll")
	procMprAdminInterfaceSetCustomInfoEx = mprapi.NewProc("MprAdminInterfaceSetCustomInfoEx")
)

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

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

typedef MprAdminInterfaceSetCustomInfoExNative = Uint32 Function(IntPtr, Pointer<Void>, Pointer<Void>);
typedef MprAdminInterfaceSetCustomInfoExDart = int Function(int, Pointer<Void>, Pointer<Void>);
final MprAdminInterfaceSetCustomInfoEx = DynamicLibrary.open('MPRAPI.dll')
    .lookupFunction<MprAdminInterfaceSetCustomInfoExNative, MprAdminInterfaceSetCustomInfoExDart>('MprAdminInterfaceSetCustomInfoEx');
// hMprServer : INT_PTR -> IntPtr
// hInterface : HANDLE -> Pointer<Void>
// pCustomInfo : MPR_IF_CUSTOMINFOEX2* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MprAdminInterfaceSetCustomInfoEx(
  hMprServer: NativeInt;   // INT_PTR
  hInterface: THandle;   // HANDLE
  pCustomInfo: Pointer   // MPR_IF_CUSTOMINFOEX2*
): DWORD; stdcall;
  external 'MPRAPI.dll' name 'MprAdminInterfaceSetCustomInfoEx';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MprAdminInterfaceSetCustomInfoEx"
  c_MprAdminInterfaceSetCustomInfoEx :: CIntPtr -> Ptr () -> Ptr () -> IO Word32
-- hMprServer : INT_PTR -> CIntPtr
-- hInterface : HANDLE -> Ptr ()
-- pCustomInfo : MPR_IF_CUSTOMINFOEX2* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mpradmininterfacesetcustominfoex =
  foreign "MprAdminInterfaceSetCustomInfoEx"
    (intptr_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hMprServer : INT_PTR -> intptr_t *)
(* hInterface : HANDLE -> (ptr void) *)
(* pCustomInfo : MPR_IF_CUSTOMINFOEX2* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mprapi (t "MPRAPI.dll"))
(cffi:use-foreign-library mprapi)

(cffi:defcfun ("MprAdminInterfaceSetCustomInfoEx" mpr-admin-interface-set-custom-info-ex :convention :stdcall) :uint32
  (h-mpr-server :int64)   ; INT_PTR
  (h-interface :pointer)   ; HANDLE
  (p-custom-info :pointer))   ; MPR_IF_CUSTOMINFOEX2*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MprAdminInterfaceSetCustomInfoEx = Win32::API::More->new('MPRAPI',
    'DWORD MprAdminInterfaceSetCustomInfoEx(LPARAM hMprServer, HANDLE hInterface, LPVOID pCustomInfo)');
# my $ret = $MprAdminInterfaceSetCustomInfoEx->Call($hMprServer, $hInterface, $pCustomInfo);
# hMprServer : INT_PTR -> LPARAM
# hInterface : HANDLE -> HANDLE
# pCustomInfo : MPR_IF_CUSTOMINFOEX2* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型