ホーム › NetworkManagement.IpHelper › LookupPersistentUdpPortReservation

LookupPersistentUdpPortReservation

関数

永続的なUDPポート予約のトークンを検索して取得する。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
StartPort	WORD	in	ネットワークバイトオーダーで指定する開始 UDP ポート番号です。
NumberOfPorts	WORD	in	予約された UDP ポート番号の数です。
Token	ULONGLONG*	out	関数が成功した場合に返されるポート予約トークンへのポインターです。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

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

解説(Remarks)

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

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

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

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

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

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

各言語での呼び出し定義

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

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

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint LookupPersistentUdpPortReservation(
    ushort StartPort,   // WORD
    ushort NumberOfPorts,   // WORD
    out ulong Token   // ULONGLONG* out
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function LookupPersistentUdpPortReservation(
    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 LookupPersistentUdpPortReservation 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

LookupPersistentUdpPortReservation = ctypes.windll.iphlpapi.LookupPersistentUdpPortReservation
LookupPersistentUdpPortReservation.restype = wintypes.DWORD
LookupPersistentUdpPortReservation.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')
LookupPersistentUdpPortReservation = Fiddle::Function.new(
  lib['LookupPersistentUdpPortReservation'],
  [
    -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 LookupPersistentUdpPortReservation(
        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 LookupPersistentUdpPortReservation(ushort StartPort, ushort NumberOfPorts, out ulong Token);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_LookupPersistentUdpPortReservation' -Namespace Win32 -PassThru
# $api::LookupPersistentUdpPortReservation(StartPort, NumberOfPorts, Token)

#uselib "IPHLPAPI.dll"
#func global LookupPersistentUdpPortReservation "LookupPersistentUdpPortReservation" sptr, sptr, sptr
; LookupPersistentUdpPortReservation StartPort, NumberOfPorts, varptr(Token)   ; 戻り値は stat
; StartPort : WORD -> "sptr"
; NumberOfPorts : WORD -> "sptr"
; Token : ULONGLONG* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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