WSAAsyncGetHostByName マクロ (wsipv6ok.h)

[アーティクル]
08/28/2023

WSAAsyncGetHostByName 関数は、ホスト名に対応するホスト情報を非同期的に取得します。

メモWSAAsyncGetHostByName 関数は、複数の名前の並列解決を提供するようには設計されていません。したがって、複数の要求を発行するアプリケーションでは、同時に実行されることを想定しないでください。または、アプリケーションで別のスレッドを開始し、 getaddrinfo 関数を使用して IP バージョンに依存しない方法で名前を解決することもできます。 Windows Sockets 2 アプリケーションを作成する開発者は、 getaddrinfo 関数を使用して、IPv6 互換性へのスムーズな移行を可能にするよう促されます。

構文

void WSAAsyncGetHostByName(
  [in]   a,
  [in]   b,
  [in]   c,
  [out]  d,
  [in]   e
);

パラメーター

[in] a

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

[in] b

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

[in] c

ホストの null で終わる名前へのポインター。

[out] d

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

[in] e

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

戻り値

なし

解説

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

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

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

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

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

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

#include <windows.h>

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

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

WSAAsyncGetHostByName は、 gethostname の正常な呼び出しによって返される文字列を解決することが保証されます。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	wsipv6ok.h (Winsock2.h、Winsock.h を含む)
Library	Ws2_32.lib
[DLL]	Ws2_32.dll