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

LookupPersistentTcpPortReservation

関数
永続的なTCPポート予約のトークンを検索して取得する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD LookupPersistentTcpPortReservation(
    WORD StartPort,
    WORD NumberOfPorts,
    ULONGLONG* Token
);

パラメーター

名前方向説明
StartPortWORDinネットワークバイトオーダーでの開始 TCP ポート番号。
NumberOfPortsWORDin予約された TCP ポート番号の数。
TokenULONGLONG*out関数が成功した場合に返される、ポート予約トークンへのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

戻り値 説明
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。このエラーは、StartPort または NumberOfPorts パラメーターにゼロが渡された場合に返されます。
ERROR_NOT_FOUND
要素が見つかりませんでした。このエラーは、StartPort および NumberOfPorts パラメーターで指定された永続的なポートブロックが見つからなかった場合に返されます。
その他
返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

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

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

TCP ポートブロックに対する永続的な予約は、CreatePersistentTcpPortReservation 関数の呼び出しによって作成されます。LookupPersistentTcpPortReservation 関数に渡す StartPort および NumberOfPorts パラメーターは、CreatePersistentTcpPortReservation 関数によって TCP ポートブロックの永続的な予約が作成されたときに使用された値と一致している必要があります。

LookupPersistentTcpPortReservation 関数が成功した場合、返される Token パラメーターは、その TCP ポートブロックに対する永続的なポート予約のトークンを指します。なお、特定の TCP ポートブロックの永続的な予約のトークンは、システムが再起動されるたびに変わる可能性があることに注意してください。

アプリケーションは、TCP socket を開き、SIO_ASSOCIATE_PORT_RESERVATION IOCTL を指定して予約トークンを渡す形で WSAIoctl 関数を呼び出した後、その socket に対して bind 関数を呼び出すことで、TCP ポート予約からのポート割り当てを要求できます。

次の例では、永続的な TCP ポート予約を検索し、socket を作成してそのポート予約からポートを割り当てます。

#ifndef UNICODE
#define UNICODE
#endif

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <Windows.h.>
#include <winsock2.h>
#include <mstcpip.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 Winsock functions
#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
    ULONG64 resToken = {0};
    
    unsigned long status = 0;

    WSADATA wsaData = { 0 };
    int iResult = 0;

    SOCKET sock = INVALID_SOCKET;
    int iFamily = AF_INET;
    int iType = SOCK_STREAM;
    int iProtocol = IPPROTO_TCP;

    DWORD bytesReturned = 0;

    // Note that the sockaddr_in struct works only with AF_INET not AF_INET6
    // An application needs to use the sockaddr_in6 for AF_INET6
    sockaddr_in service; 
    sockaddr_in sockName;
    int nameLen = sizeof(sockName);
    
    // Validate the parameters
    if (argc != 3) {
        wprintf(L"usage: %s <Starting Port> <Number of Ports>\n", 
            argv[0]);
        wprintf(L"Look up 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((USHORT) startPort);

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

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

    wprintf(L"LookupPersistentTcpPortReservation call succeeded\n");
    wprintf(L"  Token = %I64d\n", resToken);  
  
    // Comment out this block if you don't want to create a socket and associate it with the 
    // persistent reservation

    // Initialize Winsock
    iResult = WSAStartup(MAKEWORD(2, 2), &wsaData);
    if (iResult != 0) {
        wprintf(L"WSAStartup failed with error = %d\n", iResult);
        return 1;
    }

    sock = socket(iFamily, iType, iProtocol);
    if (sock == INVALID_SOCKET)
        wprintf(L"socket function failed with error = %d\n", WSAGetLastError());
    else {
        wprintf(L"socket function succeeded\n");

        iResult =
            WSAIoctl(sock, SIO_ASSOCIATE_PORT_RESERVATION, (LPVOID) & resToken,
                     sizeof (ULONG64), NULL, 0, &bytesReturned, NULL, NULL);
        if (iResult != 0) {
            wprintf
                (L"WSAIoctl(SIO_ASSOCIATE_PORT_RESERVATION) failed with error = %d\n",
                 WSAGetLastError());
        } else {
            wprintf(L"WSAIoctl(SIO_ASSOCIATE_PORT_RESERVATION) succeeded, bytesReturned = %u\n", 
                bytesReturned);                

            service.sin_family = AF_INET;
            service.sin_addr.s_addr = INADDR_ANY;
            service.sin_port = 0;

            iResult = bind(sock, (SOCKADDR*) &service, sizeof(service) );
            if (iResult == SOCKET_ERROR)
                wprintf(L"bind failed with error = %d\n", WSAGetLastError());
            else {
                wprintf(L"bind succeeded\n");
                iResult = getsockname(sock, (SOCKADDR*) &sockName, &nameLen);
                if (iResult == SOCKET_ERROR) 
                    wprintf(L"getsockname failed with error = %d\n", WSAGetLastError() );
                else {
                    wprintf(L"getsockname succeeded\n");
                    wprintf(L"Port number allocated = %u\n", ntohs(sockName.sin_port) );
                }
            }                  
        }

        if (sock != INVALID_SOCKET) {
            iResult = closesocket(sock);
            if (iResult == SOCKET_ERROR) {
                wprintf(L"closesocket failed with error = %d\n", WSAGetLastError());
            }
        }
    }
    WSACleanup();

    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 LookupPersistentTcpPortReservation(
    WORD StartPort,
    WORD NumberOfPorts,
    ULONGLONG* Token
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint LookupPersistentTcpPortReservation(
    ushort StartPort,   // WORD
    ushort NumberOfPorts,   // WORD
    out ulong Token   // ULONGLONG* out
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function LookupPersistentTcpPortReservation(
    StartPort As UShort,   ' WORD
    NumberOfPorts As UShort,   ' WORD
    <Out> ByRef Token As ULong   ' ULONGLONG* out
) As UInteger
End Function
' StartPort : WORD
' NumberOfPorts : WORD
' Token : ULONGLONG* out
Declare PtrSafe Function LookupPersistentTcpPortReservation Lib "iphlpapi" ( _
    ByVal StartPort As Integer, _
    ByVal NumberOfPorts As Integer, _
    ByRef Token As LongLong) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

LookupPersistentTcpPortReservation = ctypes.windll.iphlpapi.LookupPersistentTcpPortReservation
LookupPersistentTcpPortReservation.restype = wintypes.DWORD
LookupPersistentTcpPortReservation.argtypes = [
    ctypes.c_ushort,  # StartPort : WORD
    ctypes.c_ushort,  # NumberOfPorts : WORD
    ctypes.POINTER(ctypes.c_ulonglong),  # Token : ULONGLONG* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procLookupPersistentTcpPortReservation = iphlpapi.NewProc("LookupPersistentTcpPortReservation")
)

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

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

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

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

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

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

関連項目

公式の関連項目