WSAMSG 構造体 (ws2def.h)

WSAMSG 構造体は、LPFN_WSARECVMSG (WSARecvMsg) 関数と WSASendMsg 関数と共に使用され、接続されたソケットと接続されていないソケットに関するアドレスおよびオプションの制御情報、およびメッセージ データの格納に使用されるバッファーの配列を格納します。

構文

typedef struct _WSAMSG {
  LPSOCKADDR name;
  INT        namelen;
  LPWSABUF   lpBuffers;
#if ...
  ULONG      dwBufferCount;
#else
  DWORD      dwBufferCount;
#endif
  WSABUF     Control;
#if ...
  ULONG      dwFlags;
#else
  DWORD      dwFlags;
#endif
} WSAMSG, *PWSAMSG, *LPWSAMSG;

メンバー

name

種類: LPSOCKADDR

リモート アドレスに関する情報を格納する SOCKET_ADDRESS 構造体へのポインター。 接続されていないソケットでのみ使用されます。

namelen

型: INT

pAddr メンバーで指SOCKET_ADDRESS構造体の長さ (バイト単位)。 接続されていないソケットでのみ使用されます。

lpBuffers

型: LPWSABUF

メッセージ データの受信に使用される WSABUF 構造体の配列。 lpBuffers メンバーに複数のバッファーを含める機能を使用すると、スキャッター/ギャザー I/O を使用できます。

dwBufferCount

型: DWORD

lpBuffers メンバーで指し示されているバッファーの数。

Control

種類: WSABUF

オプションの制御データを指定するために使用される WSABUF 型の構造体。 「解説」を参照してください。

dwFlags

型: DWORD

値の論理 OR として指定された 1 つ以上の制御フラグ。 入力時に dwFlags メンバーに指定できる値は、Winsock2.h ヘッダー ファイルで定義されています。 出力時 に dwFlags メンバーに指定できる値は、Winsock2.h ヘッダー ファイルによって自動的に含まれる Ws2def.h ヘッダー ファイルで定義されます。

注釈

Microsoft Windows ソフトウェア開発キット (Windows SDK) (SDK) では、Windows Vista で使用するこの構造体のバージョンは、dwBufferCount メンバーと dwFlags メンバーのデータ型を ULONG として定義します。 ターゲット プラットフォームが Windows Vista 以降の場合にアプリケーションをコンパイルする場合 (NTDDI_VERSION >= NTDDI_LONGHORN、_WIN32_WINNT >= 0x0600、または WINVER >= 0x0600)、 dwBufferCount メンバーと dwFlags メンバーのデータ型は ULONG です。

Windows Server 2003 および Windows XP: アプリケーションをコンパイルする場合、 dwBufferCount メンバーと dwFlags メンバーの データ型は DWORD です。

Windows Vista 以降用にリリースされたWindows SDKでは、WSAMSG 構造体は Ws2def.h ヘッダー ファイルで定義されています。 Ws2def.h ヘッダー ファイルは Winsock2.h に自動的に含まれるので、直接使用しないでください

転送中にデータグラムまたは制御データが切り捨てられた場合、 WSAMSG 構造体と関連付けて使用されている関数はSOCKET_ERRORを返し、 WSAGetLastError 関数の呼び出しは WSAEMSGSIZE を返します。 MSG_TRUNCフラグやMSG_CTRUNC フラグを確認して、切り捨てられた内容を判断するのはアプリケーションの責任です。

コントロール メンバーの使用

次の表は、IPv4 および IPv6 の Control メンバーで使用できる コントロール データのさまざまな使用方法をまとめたものです。

制御データは、1 つ以上の制御データ・オブジェクトで構成され、それぞれ WSACMSGHDR 構造体で始まり、以下のように定義されます。

struct wsacmsghdr {
  UINT        cmsg_len;
  INT         cmsg_level;
  INT         cmsg_type;
  /* followed by UCHAR cmsg_data[] */
} WSACMSGHDR;

WSACMSGHDR 構造体のメンバーは次のとおりです。

データ オブジェクト内を移動するには、次のマクロを使用します。

#define LPCMSGHDR *WSA_CMSG_FIRSTHDR(LPWSAMSG msg);

最初のコントロール データ オブジェクトへのポインターを返します。 コントロール メンバーが NULL ポインターの場合など、WSAMSG 構造体にコントロール データがない場合は NULL ポインターを返します。

#define LPCMSGHDR *WSA_CMSG_NXTHDR(LPWSAMSG msg, LPWSACMSGHDR cmsg);

次のコントロール データ オブジェクトへのポインターを返します。これ以上データ オブジェクトがない場合は NULL を 返します。 pcmsg パラメーターが NULL の場合は、最初のコントロール データ オブジェクトへのポインターが返されます。

#define UCHAR *WSA_CMSG_DATA(LPWSACMSGHDR pcmsg);

データの最初のバイトへのポインターを返します (構造体では定義されていませんが、 cmsg_data メンバーと呼ばれます)。

#define UINT WSA_CMSG_SPACE(UINT length);

データの量を指定して、コントロール データ オブジェクトの合計サイズを返します。 バッファー領域の正しい量を割り当てるために使用されます。 配置のパディングが含まれます。

#define UINT WSA_CMSG_LEN(UINT length);

データの量を 指定cmsg_len の値を返します。 配置のパディングが含まれます。

要件

こちらもご覧ください

IPV6_PKTINFO

IP_PKTINFO

SOCKET_ADDRESS

Wsabuf

WSARecv

WSARecvFrom

LPFN_WSARECVMSG (WSARecvMsg)

WSASendMsg