LPWSPENUMNETWORKEVENTS コールバック関数 (ws2spi.h)

[アーティクル]
03/15/2023

LPWSPEnumNetworkEvents 関数は、指定されたソケットのネットワークイベントの発生を報告します。

構文

LPWSPENUMNETWORKEVENTS Lpwspenumnetworkevents;

int Lpwspenumnetworkevents(
  [in]  SOCKET s,
  [in]  WSAEVENT hEventObject,
  [out] LPWSANETWORKEVENTS lpNetworkEvents,
  [out] LPINT lpErrno
)
{...}

パラメーター

[in] s

ソケットを識別する記述子。

[in] hEventObject

リセットする関連イベントオブジェクトを識別するオプションのハンドル。

[out] lpNetworkEvents

発生したネットワークイベントと関連するエラーコードのレコードが格納されている WSANETWORKEVENTS 構造体へのポインター。 WSANETWORKEVENTS 構造体は、次のテキストで定義されています。

[out] lpErrno

エラーコードへのポインター。

戻り値

操作が成功した場合、戻り値は 0 です。それ以外の場合は、SOCKET_ERROR値が返され、 lpErrno で特定のエラー番号を使用できます。

エラーコード	意味
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAEINVAL	指定されたパラメーターのいずれかが無効であることを示します。
WSAEINPROGRESS	ブロックしている Windows ソケット呼び出しが進行中であるか、サービスプロバイダーがコールバック関数を処理しています。
WSAENOTSOCK	記述子はソケットではありません。

注釈

この関数は、この関数の最後の呼び出し以降に、指定されたソケットに対して発生したネットワークイベントを報告するために使用されます。これは、イベントオブジェクトを 1 つ以上のネットワークイベントに関連付ける LPWSPEventSelect および LPWSPAsyncSelect と組み合わせて使用することを目的としています。ネットワークイベントの記録は、LPWSPEventSelect または LPWSPAsyncSelect が 0 以外の lNetworkEvents 引数で呼び出されると開始され、lNetworkEvents 引数がゼロに設定された LPWSPEventSelect または LPWSPAsyncSelect に対して別の対応する呼び出しが行われるまで有効です。

LPWSPEnumNetworkEvents は、LPWSPEventSelect によって指名されたネットワークアクティビティとエラーのみを報告します。 LPWSPSelect と LPWSPAsyncSelect の説明を参照して、これらの関数がネットワークアクティビティとエラーを報告する方法を確認してください。

ネットワークイベントのソケットの内部レコードは、 lpNetworkEvents によって参照される構造体にコピーされ、その後、内部ネットワークイベントレコードがクリアされます。 hEventObject が null 以外の場合、指定されたイベントオブジェクトもリセットされます。 Windows ソケットプロバイダーは、ネットワークイベントレコードをコピーし、それをクリアし、関連するイベントオブジェクトをリセットする操作がアトミックであることを保証します。これにより、指定されたネットワークイベントが次に発生すると、イベントオブジェクトが設定されます。この関数がSOCKET_ERRORを返す場合、関連付けられたイベントオブジェクトはリセットされず、ネットワークイベントのレコードはクリアされません。

WSANETWORKEVENTS 構造体は、WSANETWORKEVENTS 参照ページで定義されています。

WSANETWORKEVENTS 構造体の lNetworkEvents メンバーは、FD_XXXネットワークイベントのうち発生したイベントを示します。 iErrorCode 配列は、関連するエラーコードを格納するために使用され、lNetworkEvents 内のイベントビットの位置に対応する配列インデックスが含まれます。 FD_READ_BITやFD_WRITE_BITなどの識別子を使用して、 iErrorCode 配列のインデックスを作成できます。

iErrorCode 配列の要素のみが、lNetworkEvents メンバーで設定されたビットに対応して設定されることに注意してください。他のメンバーは変更されません (これは、新しいFD_ROUTING_INTERFACE_CHANGEおよびFD_ADDRESS_LIST_CHANGEイベントを認識していない Windows Socket 2 SPI クライアントとの下位互換性のために重要です)。

次のエラーコードは、それぞれのネットワークイベントと共に返すことができます。

イベント: FD_CONNECT

エラーコード	意味
WSAEAFNOSUPPORT	指定されたファミリーのアドレスをこのソケットと共に使用することはできません。
WSAECONNREFUSED	接続の試行が強制的に拒否されました。
WSAENETUNREACH	現在このホストからネットワークには到達できません。
WSAENOBUFS	バッファーに空き領域がありません。ソケットを接続できません。
WSAETIMEDOUT	接続を確立せずに接続試行がタイムアウトしました。

イベント: FD_CLOSE

エラーコード	意味
WSAENETDOWN	ネットワークサブシステムが失敗しました。
WSAECONNRESET	リモート側で接続がリセットされました。
WSAECONNABORTED	タイムアウトまたはその他のエラーが原因で接続が終了しました。

イベント: FD_READ、FD_WRITE、FD_OOB、FD_ACCEPT、FD_QOS、FD_GROUP_QOS、FD_ADDRESS_LIST_CHANGE

エラーコード	意味
WSAENETDOWN	ネットワークサブシステムが失敗しました。

イベント: FD_ROUTING_INTERFACE_CHANGE

エラーコード	意味
WSAENETUNREACH	指定した宛先に到達できなくなりました。
WSAENETDOWN	ネットワークサブシステムが失敗しました。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
Header	ws2spi.h

こちらもご覧ください

LPWSPEventSelect

次の方法で共有