GetUdp6Table 関数 (iphlpapi.h)

[アーティクル]
03/13/2024

GetUdp6Table 関数は、IPv6 ユーザーデータグラムプロトコル (UDP) リスナーテーブルを取得します。

構文

IPHLPAPI_DLL_LINKAGE ULONG GetUdp6Table(
  [out]     PMIB_UDP6TABLE Udp6Table,
  [in, out] PULONG         SizePointer,
  [in]      BOOL           Order
);

パラメーター

[out] Udp6Table

IPv6 UDP リスナーテーブルを MIB_UDP6TABLE 構造体として受け取るバッファーへのポインター。

[in, out] SizePointer

入力時に、 Udp6Table パラメーターが指すバッファーのサイズをバイト単位で指定します。

出力時に、バッファーが返されたリスナーテーブルを保持するのに十分な大きさでない場合、関数は、このパラメーターを必要なバッファーサイズ (バイト単位) に設定します。

[in] Order

返された UDP リスナーテーブルを並べ替える必要があるかどうかを示すブール値。このパラメーターが TRUE の場合、テーブルは次の順序で並べ替えられます。

ローカル IPv6 アドレス
ローカルスコープ ID
ローカルポート

戻り値

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

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

リターンコード	説明
ERROR_INSUFFICIENT_BUFFER	Udp6Table パラメーターが指すバッファーの大きさが十分ではありません。 SizePointer パラメーターが指す ULONG 変数で、必要なサイズが返されます。
ERROR_INVALID_PARAMETER	SizePointer パラメーターが NULL であるか、GetUdp6Table が SizePointer パラメーターが指すメモリに書き込むことができません。
ERROR_NOT_SUPPORTED	この関数は、ローカルシステムで使用されているオペレーティングシステムではサポートされていません。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	iphlpapi.h
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll