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

SetIpTTL

関数
送信IPパケットの既定のTTL(生存時間)値を設定する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SetIpTTL(
    DWORD nTTL
);

パラメーター

名前方向説明
nTTLDWORDinローカルコンピューターの新しい TTL 値です。

戻り値の型: DWORD

公式ドキュメント

SetIpTTL 関数は、ローカルコンピューターの既定の time-to-live (TTL) 値を設定します。

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは Windows Vista および Windows Server 2008 において、次のような複数の条件で返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者特権を持っていない、またはアプリケーションが組み込みの Administrator として拡張シェル (RunAs administrator) で実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは nTTL パラメーターが無効な場合に返されます。
その他
返されたエラーに対応するメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

既定の TTL は、 SetIpStatistics 関数を使用して設定することもできます。

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

SetIpStatistics 関数は、Windows Vista 以降のユーザーアカウント制御 (UAC) が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数を成功させるために、組み込みの Administrator として拡張シェル (RunAs 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 SetIpTTL(
    DWORD nTTL
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetIpTTL(
    uint nTTL   // DWORD
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetIpTTL(
    nTTL As UInteger   ' DWORD
) As UInteger
End Function
' nTTL : DWORD
Declare PtrSafe Function SetIpTTL Lib "iphlpapi" ( _
    ByVal nTTL As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetIpTTL = ctypes.windll.iphlpapi.SetIpTTL
SetIpTTL.restype = wintypes.DWORD
SetIpTTL.argtypes = [
    wintypes.DWORD,  # nTTL : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
SetIpTTL = Fiddle::Function.new(
  lib['SetIpTTL'],
  [
    -Fiddle::TYPE_INT,  # nTTL : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "iphlpapi")]
extern "system" {
    fn SetIpTTL(
        nTTL: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint SetIpTTL(uint nTTL);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_SetIpTTL' -Namespace Win32 -PassThru
# $api::SetIpTTL(nTTL)
#uselib "IPHLPAPI.dll"
#func global SetIpTTL "SetIpTTL" sptr
; SetIpTTL nTTL   ; 戻り値は stat
; nTTL : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "IPHLPAPI.dll"
#cfunc global SetIpTTL "SetIpTTL" int
; res = SetIpTTL(nTTL)
; nTTL : DWORD -> "int"
; DWORD SetIpTTL(DWORD nTTL)
#uselib "IPHLPAPI.dll"
#cfunc global SetIpTTL "SetIpTTL" int
; res = SetIpTTL(nTTL)
; nTTL : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetIpTTL = iphlpapi.NewProc("SetIpTTL")
)

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

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

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

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

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

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

関連項目

公式の関連項目