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

SetTcpEntry

関数
指定TCP接続の状態を変更し接続を終了させる。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD SetTcpEntry(
    MIB_TCPROW_LH* pTcpRow
);

パラメーター

名前方向説明
pTcpRowMIB_TCPROW_LH*inMIB_TCPROW 構造体へのポインターです。この構造体は、変更対象の TCP 接続を識別するための情報を指定します。また、TCP 接続の新しい状態も指定します。呼び出し元は、この構造体のすべてのメンバーに値を指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

SetTcpEntry 関数は、TCP 接続の状態を設定します。

戻り値

関数が成功した場合、NO_ERROR(ゼロ)を返します。

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

戻り値/値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、Windows Vista および Windows Server 2008 において、次を含むいくつかの条件で返されます。すなわち、ユーザーがローカルコンピューター上で必要な管理者特権を持っていない場合、またはアプリケーションが組み込みの Administrator として昇格されたシェル(管理者として実行)で実行されていない場合です。
ERROR_INVALID_PARAMETER
入力パラメーターが無効であり、何の操作も行われませんでした。このエラーは、pTcpRow パラメーターが NULL である場合、または pTcpRow パラメーターが指す MIB_TCPROW 構造体の Row メンバーが MIB_TCP_STATE_DELETE_TCB に設定されていない場合に返されます。
ERROR_NOT_SUPPORTED
ローカルコンピューターで IPv4 トランスポートが構成されていません。
317
アプリケーションが非昇格状態で実行されているため、関数は TCP エントリを設定できません。
その他

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

解説(Remarks)

現在、TCP 接続に設定できる状態は MIB_TCP_STATE_DELETE_TCB のみです。

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

SetTcpEntry 関数は、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 SetTcpEntry(
    MIB_TCPROW_LH* pTcpRow
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint SetTcpEntry(
    IntPtr pTcpRow   // MIB_TCPROW_LH*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function SetTcpEntry(
    pTcpRow As IntPtr   ' MIB_TCPROW_LH*
) As UInteger
End Function
' pTcpRow : MIB_TCPROW_LH*
Declare PtrSafe Function SetTcpEntry Lib "iphlpapi" ( _
    ByVal pTcpRow As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetTcpEntry = ctypes.windll.iphlpapi.SetTcpEntry
SetTcpEntry.restype = wintypes.DWORD
SetTcpEntry.argtypes = [
    ctypes.c_void_p,  # pTcpRow : MIB_TCPROW_LH*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procSetTcpEntry = iphlpapi.NewProc("SetTcpEntry")
)

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

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

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

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

let settcpentry =
  foreign "SetTcpEntry"
    ((ptr void) @-> returning uint32_t)
(* pTcpRow : MIB_TCPROW_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 ("SetTcpEntry" set-tcp-entry :convention :stdcall) :uint32
  (p-tcp-row :pointer))   ; MIB_TCPROW_LH*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetTcpEntry = Win32::API::More->new('IPHLPAPI',
    'DWORD SetTcpEntry(LPVOID pTcpRow)');
# my $ret = $SetTcpEntry->Call($pTcpRow);
# pTcpRow : MIB_TCPROW_LH* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型