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

SetIpStatistics

関数
IP転送の有効化やデフォルトTTLなどのIP設定を行う。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SetIpStatistics(
    MIB_IPSTATS_LH* pIpStats
);

パラメーター

名前方向説明
pIpStatsMIB_IPSTATS_LH*inMIB_IPSTATS 構造体へのポインターです。呼び出し側は、この構造体の dwForwarding メンバーと dwDefaultTTL メンバーに新しい値を設定する必要があります。いずれかのメンバーを現在の値のまま維持するには、MIB_USE_CURRENT_TTL または MIB_USE_CURRENT_FORWARDING を使用します。

戻り値の型: DWORD

公式ドキュメント

SetIpStatistics 関数は、IP 転送のオン/オフを切り替え、ローカルコンピューターの既定の TTL (time-to-live) 値を設定します。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、Windows Vista および Windows Server 2008 で、次のような複数の条件下で返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator として拡張シェルで実行されていない (管理者として実行されていない) 場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、pIpStats パラメーターに NULL ポインターが渡された場合に返されます。また、pIpStats パラメーターが指す MIB_IPSTATS 構造体の dwForwarding メンバーに、MIB_IP_NOT_FORWARDINGMIB_IP_FORWARDINGMIB_USE_CURRENT_FORWARDING 以外の値が含まれている場合にも返されます。
その他

FormatMessage を使用して、返されたエラーに対応するメッセージ文字列を取得してください。

解説(Remarks)

既定の TTL のみを設定する場合は、呼び出し側は SetIpTTL 関数を使用することもできます。

Windows Vista 以降では、SetIpStatistics 関数は Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが SetIpStatistics を呼び出した場合、関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。

SetIpStatistics 関数は、Windows Vista 以降のユーザーアカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、アプリケーションのマニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator として拡張シェル (管理者として実行) でアプリケーションを実行する必要があります。

注意 Windows NT 4.0 および Windows 2000 以降では、この関数は特権操作を実行します。この関数を正常に実行するには、呼び出し側が Administrators グループまたは NetworkConfigurationOperators グループのメンバーとしてログオンしている必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

SetIpStatistics = ctypes.windll.iphlpapi.SetIpStatistics
SetIpStatistics.restype = wintypes.DWORD
SetIpStatistics.argtypes = [
    ctypes.c_void_p,  # pIpStats : MIB_IPSTATS_LH*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetIpStatistics = iphlpapi.NewProc("SetIpStatistics")
)

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

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

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

foreign import stdcall safe "SetIpStatistics"
  c_SetIpStatistics :: Ptr () -> IO Word32
-- pIpStats : MIB_IPSTATS_LH* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("SetIpStatistics" set-ip-statistics :convention :stdcall) :uint32
  (p-ip-stats :pointer))   ; MIB_IPSTATS_LH*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetIpStatistics = Win32::API::More->new('IPHLPAPI',
    'DWORD SetIpStatistics(LPVOID pIpStats)');
# my $ret = $SetIpStatistics->Call($pIpStats);
# pIpStats : MIB_IPSTATS_LH* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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