GetUdpTable 関数 (iphlpapi.h)

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

構文

IPHLPAPI_DLL_LINKAGE ULONG GetUdpTable(
  [out]     PMIB_UDPTABLE UdpTable,
  [in, out] PULONG        SizePointer,
  [in]      BOOL          Order
);

[out] UdpTable

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

[in, out] SizePointer

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

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

Windows Vista 以降用にリリースされた Windows SDK では、このパラメーターのデータ型が PDWORD と同等の PULONG に変更されます。

[in] Order

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

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

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

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

Windows Vista 以降用にリリースされた Windows SDK では、GetUdpTable 関数からの戻り値が、DWORD と同等の ULONG のデータ型に変更されます。


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	iphlpapi.h
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll