ホーム › NetworkManagement.IpHelper › SetIpStatisticsEx

SetIpStatisticsEx

関数

指定アドレスファミリのIP統計パラメータを設定する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD SetIpStatisticsEx(
    MIB_IPSTATS_LH* Statistics,
    DWORD Family
);

パラメーター

名前

型

方向

説明

Statistics

MIB_IPSTATS_LH*

MIB_IPSTATS 構造体へのポインターです。呼び出し元はこの構造体の dwForwarding メンバーと dwDefaultTTL メンバーに新しい値を設定します。いずれかのメンバーを現在の値のまま維持するには、MIB_USE_CURRENT_TTL または MIB_USE_CURRENT_FORWARDING を使用してください。

Family

DWORD

転送および TTL を設定する対象のアドレスファミリです。

アドレスファミリに指定できる値は Winsock2.h ヘッダーファイルに記載されています。AF_ アドレスファミリ定数と PF_ プロトコルファミリ定数の値は同一である (たとえば AF_INET と PF_INET) ため、どちらの定数を使用してもかまいません。

Windows Vista 以降向けにリリースされた Windows SDK では、ヘッダーファイルの構成が変更され、このメンバーに指定できる値は Ws2def.h ヘッダーファイルで定義されています。なお、Ws2def.h ヘッダーファイルは Winsock2.h に自動的にインクルードされるため、直接使用しないでください。

現在サポートされている値は AF_INET および AF_INET6 です。

値	意味
AF_INET 2	インターネットプロトコルバージョン 4 (IPv4) アドレスファミリです。このパラメーターを指定すると、この関数は IPv4 エントリの転送および TTL オプションを設定します。
AF_INET6 23	インターネットプロトコルバージョン 6 (IPv6) アドレスファミリです。このパラメーターを指定すると、この関数は IPv6 エントリの転送および TTL オプションを設定します。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは、次を含むいくつかの条件下で返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator (管理者として実行) として昇格されたシェルで実行されていない場合です。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、pIpStats パラメーターに NULL ポインターが渡された場合、または Family パラメーターが AF_INET および AF_INET6 に設定されていない場合に返されます。また、pIpStats パラメーターが指す MIB_IPSTATS 構造体の dwForwarding メンバーが MIB_IP_NOT_FORWARDING、MIB_IP_FORWARDING、または MIB_USE_CURRENT_FORWARDING 以外の値を含んでいる場合にも返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しないのに Family パラメーターで AF_INET が指定された場合、またはローカルコンピューターに IPv6 スタックが存在しないのに Family メンバーで AF_INET6 が指定された場合に返されます。
その他	返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

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

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

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

各言語での呼び出し定義

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

DWORD SetIpStatisticsEx(
    MIB_IPSTATS_LH* Statistics,
    DWORD Family
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpStatisticsEx(
    IntPtr Statistics,   // MIB_IPSTATS_LH*
    uint Family   // DWORD
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpStatisticsEx(
    Statistics As IntPtr,   ' MIB_IPSTATS_LH*
    Family As UInteger   ' DWORD
) As UInteger
End Function

' Statistics : MIB_IPSTATS_LH*
' Family : DWORD
Declare PtrSafe Function SetIpStatisticsEx Lib "iphlpapi" ( _
    ByVal Statistics As LongPtr, _
    ByVal Family As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

SetIpStatisticsEx = ctypes.windll.iphlpapi.SetIpStatisticsEx
SetIpStatisticsEx.restype = wintypes.DWORD
SetIpStatisticsEx.argtypes = [
    ctypes.c_void_p,  # Statistics : MIB_IPSTATS_LH*
    wintypes.DWORD,  # Family : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpStatisticsEx = Fiddle::Function.new(
  lib['SetIpStatisticsEx'],
  [
    Fiddle::TYPE_VOIDP,  # Statistics : MIB_IPSTATS_LH*
    -Fiddle::TYPE_INT,  # Family : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn SetIpStatisticsEx(
        Statistics: *mut MIB_IPSTATS_LH,  // MIB_IPSTATS_LH*
        Family: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetIpStatisticsEx(IntPtr Statistics, uint Family);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpStatisticsEx' -Namespace Win32 -PassThru
# $api::SetIpStatisticsEx(Statistics, Family)

#uselib "IPHLPAPI.dll"
#func global SetIpStatisticsEx "SetIpStatisticsEx" sptr, sptr
; SetIpStatisticsEx varptr(Statistics), Family   ; 戻り値は stat
; Statistics : MIB_IPSTATS_LH* -> "sptr"
; Family : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global SetIpStatisticsEx "SetIpStatisticsEx" var, int
; res = SetIpStatisticsEx(Statistics, Family)
; Statistics : MIB_IPSTATS_LH* -> "var"
; Family : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global SetIpStatisticsEx "SetIpStatisticsEx" sptr, int
; res = SetIpStatisticsEx(varptr(Statistics), Family)
; Statistics : MIB_IPSTATS_LH* -> "sptr"
; Family : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。