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

UnenableRouter

関数
EnableRouterで有効化したIP転送を無効化する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD UnenableRouter(
    OVERLAPPED* pOverlapped,
    DWORD* lpdwEnableCount   // optional
);

パラメーター

名前方向説明
pOverlappedOVERLAPPED*inOVERLAPPED 構造体へのポインター。この構造体は、EnableRouter 関数の呼び出しで使用したものと同一である必要があります。
lpdwEnableCountDWORD*outoptionalDWORD 変数への省略可能なポインター。この変数は、残りの参照数を受け取ります。

戻り値の型: DWORD

公式ドキュメント

UnenableRouter 関数は、IPv4 フォワーディングを有効にする要求の数を追跡する参照カウントをデクリメントします。この参照カウントが 0 に達すると、UnenableRouter はローカルコンピューター上の IPv4 フォワーディングを無効にします。

戻り値

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

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

解説(Remarks)

UnenableRouter 関数は IPv4 フォワーディングに固有のものです。プロセスが UnenableRouter を呼び出すたびに、同一のプロセスによる以前の EnableRouter の呼び出しと対応している必要があります。余分な UnenableRouter の呼び出しに対しては、システムはエラーを返します。その結果、あるプロセスが、別のプロセスのために IPv4 フォワーディングを有効にする要求の数を追跡する参照カウントをデクリメントすることはできません。また、あるプロセスによって IPv4 フォワーディングが有効化された場合、それを別のプロセスが無効化することはできません。

他にも未処理の EnableRouter 要求が存在する可能性があるため、IPv4 フォワーディングを有効にする要求の数を追跡する参照カウントを正確に判定することはできません。 そのため、lpdwEnableCount パラメーターに対して返される値は、常に ULONG_MAX/2 に等しい大きなカウントになります。

EnableRouter を呼び出したプロセスが UnenableRouter を呼び出さずに終了した場合、システムは、そのプロセスが UnenableRouter を呼び出したかのように、IPv4 フォワーディングを有効にする要求を追跡する参照カウントをデクリメントします。

UnenableRouter を呼び出した後は、CloseHandle 呼び出しを使用して、OVERLAPPED 構造体内のイベントオブジェクトへのハンドルを閉じます。

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

各言語での呼び出し定義

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

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

UnenableRouter = ctypes.windll.iphlpapi.UnenableRouter
UnenableRouter.restype = wintypes.DWORD
UnenableRouter.argtypes = [
    ctypes.c_void_p,  # pOverlapped : OVERLAPPED*
    ctypes.POINTER(wintypes.DWORD),  # lpdwEnableCount : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procUnenableRouter = iphlpapi.NewProc("UnenableRouter")
)

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

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

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

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

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

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

関連項目

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