WSAAsyncGetProtoByNumber 関数 (winsock2.h)

WSAAsyncGetProtoByNumber 関数は、プロトコル番号に対応するプロトコル情報を非同期的に取得します。

構文

HANDLE WSAAPI WSAAsyncGetProtoByNumber(
  [in]  HWND  hWnd,
  [in]  u_int wMsg,
  [in]  int   number,
  [out] char  *buf,
  [in]  int   buflen
);

パラメーター

[in] hWnd

非同期要求が完了したときにメッセージを受信するウィンドウのハンドル。

[in] wMsg

非同期要求が完了したときに受信するメッセージ。

[in] number

解決するプロトコル番号 (ホストのバイト順)。

[out] buf

原産地データを受信するデータ領域へのポインター。 データ領域は、データ領域が Windows ソケットによって使用され、原産地構造のメンバーによって参照されるすべてのデータを格納するために使用されるため、データ領域は原生構造体のサイズよりも大きくする必要があります。 MAXGETHOSTSTRUCT バイトのバッファーをお勧めします。

[in] buflen

buf パラメーターのデータ領域のサイズ (バイト単位)。

戻り値

戻り値は、非同期操作が正常に開始されたかどうかを指定します。 これは、操作自体の成功または失敗を意味するものではありません。

エラーが発生しない場合、 WSAAsyncGetProtoByNumber は、要求の非同期タスク ハンドルである HANDLE 型の 0 以外の値を返します (Windows HTASK と混同しないでください)。 この値は、2 つの方法で使用できます。 WSACancelAsyncRequest を使用して操作を取り消すために使用することも、wParam メッセージ パラメーターを調べることで非同期操作と完了メッセージを照合するために使用することもできます。

非同期操作を開始できなかった場合、 WSAAsyncGetProtoByNumber は 0 の値を返し、 WSAGetLastError を呼び出すことで特定のエラー番号を取得できます。

次のエラー コードは、アプリケーション ウィンドウがメッセージを受信したときに設定できます。 前述のように、WSAGETASYNCERROR マクロを使用して、応答メッセージ内の lParam から抽出できます。

関数呼び出し時に次のエラーが発生する可能性があり、非同期操作を開始できなかったことを示します。

注釈

WSAAsyncGetProtoByNumber 関数は、getprotobynumber の非同期バージョンであり、プロトコル番号に対応するプロトコル名と番号を取得するために使用されます。 Windows ソケットは操作を開始し、呼び出し元にすぐに戻り、アプリケーションが操作を識別するために使用できる不透明な非同期タスク ハンドルを返します。 操作が完了すると、結果 (存在する場合) が呼び出し元によって提供されるバッファーにコピーされ、メッセージがアプリケーションのウィンドウに送信されます。

非同期操作が完了すると、 hWnd パラメーターによって示されるアプリケーション ウィンドウは 、wMsg パラメーターでメッセージを受信します。 wParam パラメーターには、元の関数呼び出しによって返される非同期タスク ハンドルが含まれています。 lParam の上位 16 ビットには、エラー コードが含まれています。 エラー コードには、Winsock2.h で定義されている任意のエラーを指定できます。 エラー コード 0 は、非同期操作が正常に完了したことを示します。

正常に完了すると、元の関数呼び出しに指定されたバッファーには 、プロトエント 構造体が含まれます。 この構造体のメンバーにアクセスするために、元のバッファー アドレスが プロトエント 構造体ポインターにキャストされ、必要に応じてアクセスされます。

エラー コードが WSAENOBUFS の場合、元の呼び出しで buflen によって指定されたバッファーのサイズが小さすぎて、結果のすべての情報が格納されませんでした。 この場合、 lParam の下位 16 ビットには、必要なすべての情報を提供するために必要なバッファーのサイズが含まれます。 部分的なデータが不十分であるとアプリケーションが判断した場合、 WSAAsyncGetProtoByNumber 関数呼び出しを、必要なすべての情報を受け取るのに十分な大きさのバッファーを使用して再発行できます (つまり、 lParam の 16 ビット未満)。

この関数に指定されたバッファーは、同じ原始構造のメンバーによって参照されるデータ領域の内容と共に、原始構造を構築するために Windows Sockets によって使用されます。 上記の WSAENOBUFS エラーを回避するために、アプリケーションは少なくとも MAXGETHOSTSTRUCT バイトのバッファーを提供する必要があります (Winsock2.h で定義されています)。

エラー コードとバッファー長は、Winsock2.h で次のように定義されているマクロ WSAGETASYNCERROR と WSAGETASYNCBUFLEN を使用して lParam から抽出する必要があります。

#include <windows.h>

#define WSAGETASYNCBUFLEN(lParam)           LOWORD(lParam)
#define WSAGETASYNCERROR(lParam)            HIWORD(lParam)

これらのマクロを使用すると、アプリケーションのソース コードの移植性が最大化されます。

要件

こちらもご覧ください

WSACancelAsyncRequest

Winsock 関数

Winsock リファレンス

getprotobynumber