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

DeletePersistentTcpPortReservation

関数
永続的なTCPポート予約を削除する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DeletePersistentTcpPortReservation(
    WORD StartPort,
    WORD NumberOfPorts
);

パラメーター

名前方向説明
StartPortWORDinネットワークバイトオーダーでの開始 TCP ポート番号。
NumberOfPortsWORDin削除する TCP ポート番号の数。

戻り値の型: DWORD

公式ドキュメント

ローカルコンピューター上の連続した TCP ポートのブロックに対する永続的な TCP ポート予約を削除します。(DeletePersistentTcpPortReservation)

戻り値

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

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

戻り値 説明
ERROR_ACCESS_DENIED
アクセスが拒否されました。このエラーは、次を含むいくつかの条件下で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない、またはアプリケーションが組み込みの Administrator (RunAs administrator) として昇格されたシェルで実行されていない場合です。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、StartPort または NumberOfPorts パラメーターにゼロが渡された場合に返されます。
ERROR_NOT_FOUND
要素が見つかりませんでした。このエラーは、StartPort および NumberOfPorts パラメーターで指定された永続的なポートブロックが見つからなかった場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

DeletePersistentTcpPortReservation 関数は、Windows Vista 以降で定義されています。

DeletePersistentTcpPortReservation 関数は、TCP ポートのブロックに対する永続的な予約を削除するために使用されます。

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

次の例では、永続的な TCP ポート予約を削除します。

この例は、Administrators グループのメンバーであるユーザーが実行する必要があります。この例を実行する最も簡単な方法は、組み込みの Administrator (RunAs administrator) として昇格されたシェルで実行することです。

#ifndef UNICODE
#define UNICODE
#endif

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <Windows.h.>
#include <winsock2.h>
#include <ws2ipdef.h> 
#include <iphlpapi.h>
#include <stdio.h>
#include <stdlib.h>

// Need to link with iphlpapi.lib
#pragma comment(lib, "iphlpapi.lib")

// Need to link with ws2_32.lib for htons
#pragma comment(lib, "ws2_32.lib")

int wmain(int argc, WCHAR **argv)  {

    // Declare and initialize variables
    
    int startPort = 0;         // host byte order
    int numPorts = 0;
    USHORT startPortns = 0;    // Network byte order
    
    unsigned long status = 0;

    // Validate the parameters
    if (argc != 3) {
        wprintf(L"usage: %s <Starting Port> <Number of Ports>\n", argv[0]);
        wprintf(L"Delete a persistent TCP port reservation\n");
        wprintf(L"Example usage:\n");
        wprintf(L"   %s 5000 20\n", argv[0]);
        wprintf(L"   where StartPort=5000 NumPorts=20");
        return 1;
    }

    startPort = _wtoi(argv[1]);
    if ( startPort < 0 || startPort> 65535) {
        wprintf(L"Starting point must be either 0 or between 1 and 65,535\n");
        return 1;
    }    
    startPortns = htons((u_short) startPort);

    numPorts = _wtoi(argv[2]);
    if (numPorts < 0) {
        wprintf(L"Number of ports must be a positive number\n");
        return 1;
    }    

    status = DeletePersistentTcpPortReservation((USHORT) startPortns, (USHORT) numPorts);
    if( status != NO_ERROR )
    {
        wprintf(L"DeletePersistentTcpPortReservation returned error: %ld\n", 
            status);
        return 1;
    }

    wprintf(L"DeletePersistentTcpPortReservation call succeeded\n");  

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

各言語での呼び出し定義

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

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

DeletePersistentTcpPortReservation = ctypes.windll.iphlpapi.DeletePersistentTcpPortReservation
DeletePersistentTcpPortReservation.restype = wintypes.DWORD
DeletePersistentTcpPortReservation.argtypes = [
    ctypes.c_ushort,  # StartPort : WORD
    ctypes.c_ushort,  # NumberOfPorts : WORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procDeletePersistentTcpPortReservation = iphlpapi.NewProc("DeletePersistentTcpPortReservation")
)

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

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

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

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

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

(cffi:defcfun ("DeletePersistentTcpPortReservation" delete-persistent-tcp-port-reservation :convention :stdcall) :uint32
  (start-port :uint16)   ; WORD
  (number-of-ports :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeletePersistentTcpPortReservation = Win32::API::More->new('IPHLPAPI',
    'DWORD DeletePersistentTcpPortReservation(WORD StartPort, WORD NumberOfPorts)');
# my $ret = $DeletePersistentTcpPortReservation->Call($StartPort, $NumberOfPorts);
# StartPort : WORD -> WORD
# NumberOfPorts : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目