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

EnableRouter

関数
システムのIP転送(ルーター機能)を有効にする。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD EnableRouter(
    HANDLE* pHandle,
    OVERLAPPED* pOverlapped
);

パラメーター

名前方向説明
pHandleHANDLE*outハンドルへのポインター。このパラメーターは現在使用されていません。
pOverlappedOVERLAPPED*outOVERLAPPED 構造体へのポインター。hEvent メンバーを除き、この構造体のすべてのメンバーは 0 に設定する必要があります。hEvent メンバーには、有効なイベントオブジェクトへのハンドルを格納する必要があります。このイベントオブジェクトを作成するには、 CreateEvent 関数を使用します。

戻り値の型: DWORD

公式ドキュメント

EnableRouter 関数は、ローカルコンピューター上で IPv4 転送を有効にします。EnableRouter は、IPv4 転送を有効にする要求の数を追跡する参照カウントも増加させます。

戻り値

EnableRouter 関数が成功した場合、戻り値は ERROR_IO_PENDING です。

関数が失敗した場合は、FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

戻り値 説明
ERROR_INVALID_PARAMETER
パラメーターのいずれかが無効です。このエラーは、pOverlapped パラメーターが NULL の場合に返されます。
その他
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

解説(Remarks)

EnableRouter 関数は IPv4 転送に固有のものです。EnableRouter を呼び出したプロセスが UnenableRouter を呼び出さずに終了した場合、システムは、そのプロセスが UnenableRouter を呼び出したかのように、IPv4 転送を有効にする要求の数を追跡する参照カウントを減少させます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

EnableRouter = ctypes.windll.iphlpapi.EnableRouter
EnableRouter.restype = wintypes.DWORD
EnableRouter.argtypes = [
    ctypes.c_void_p,  # pHandle : HANDLE* out
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procEnableRouter = iphlpapi.NewProc("EnableRouter")
)

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

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

typedef EnableRouterNative = Uint32 Function(Pointer<Void>, Pointer<Void>);
typedef EnableRouterDart = int Function(Pointer<Void>, Pointer<Void>);
final EnableRouter = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<EnableRouterNative, EnableRouterDart>('EnableRouter');
// pHandle : HANDLE* out -> Pointer<Void>
// pOverlapped : OVERLAPPED* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function EnableRouter(
  pHandle: Pointer;   // HANDLE* out
  pOverlapped: Pointer   // OVERLAPPED* out
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'EnableRouter';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "EnableRouter"
  c_EnableRouter :: Ptr () -> Ptr () -> IO Word32
-- pHandle : HANDLE* out -> Ptr ()
-- pOverlapped : OVERLAPPED* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let enablerouter =
  foreign "EnableRouter"
    ((ptr void) @-> (ptr void) @-> returning uint32_t)
(* pHandle : HANDLE* out -> (ptr void) *)
(* pOverlapped : OVERLAPPED* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("EnableRouter" enable-router :convention :stdcall) :uint32
  (p-handle :pointer)   ; HANDLE* out
  (p-overlapped :pointer))   ; OVERLAPPED* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $EnableRouter = Win32::API::More->new('IPHLPAPI',
    'DWORD EnableRouter(HANDLE pHandle, LPVOID pOverlapped)');
# my $ret = $EnableRouter->Call($pHandle, $pOverlapped);
# pHandle : HANDLE* out -> HANDLE
# pOverlapped : OVERLAPPED* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型