setipv4sourcefilter 関数 (ws2tcpip.h)
setipv4sourcefilter インライン関数は、IPv4 ソケットのマルチキャスト フィルター状態を設定します。
構文
int setipv4sourcefilter(
[in] SOCKET Socket,
[in] IN_ADDR Interface,
[in] IN_ADDR Group,
[in] MULTICAST_MODE_TYPE FilterMode,
[in] ULONG SourceCount,
[in] const IN_ADDR *SourceList
);
パラメーター
[in] Socket
マルチキャスト ソケットを識別する記述子。
[in] Interface
マルチキャスト グループを参加または削除する必要があるインターフェイスまたはインターフェイス インデックスのローカル IPv4 アドレス。
この値はネットワークのバイト順です。 このメンバーが IPv4 アドレス 0.0.0.0 を指定した場合、既定の IPv4 マルチキャスト インターフェイスが使用されます。
IPv4 アドレス 0.0.0.0 を除く 0.x.x.x ブロック内の IP アドレス (最初のオクテット 0) は、インターフェイス インデックスとして扱われます。 インターフェイス インデックスは 24 ビット番号であり、0.0.0.0/8 IPv4 アドレス ブロックは使用されません (この範囲は予約されています)。
インターフェイス インデックス 1 を使用するには、IP アドレス 0.0.0.1 と同じになります。
[in] Group
マルチキャスト グループの IPv4 アドレス。
[in] FilterMode
マルチキャスト グループ アドレスのマルチキャスト フィルター モード。
[in] SourceCount
SourceList パラメーターが指すバッファー内のソース アドレスの数。
[in] SourceList
マルチキャスト フィルターに関連付ける IP アドレスを持つバッファーへのポインター。
戻り値
成功すると、 setipv4sourcefilter は NO_ERROR (0) を返します。 0 以外の戻り値はエラーを示し、 WSAGetLastError を呼び出すことで特定のエラー コードを取得できます。
| エラー コード | 意味 |
|---|---|
| バッファー領域が不足しています。 | |
| 記述子はソケットではありません。 |
注釈
setipv4sourcefilter インライン関数は、IPv4 ソケットのマルチキャスト フィルター状態を設定するために使用されます。
この関数は、RFC 3678 で定義されているマルチキャスト ソース フィルターのソケット インターフェイス拡張機能の一部です。 アプリでは、これらの関数を使用して、ソケットに関連付けられているマルチキャスト ソース アドレス フィルターを取得および設定できます。
Windows Phone 8: この関数は、Windows Phone 8 以降の Windows Phone ストア アプリでサポートされています。
Windows 8.1とWindows Server 2012 R2: この関数は、Windows 8.1、Windows Server 2012 R2 以降の Windows ストア アプリでサポートされています。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows 8.1、Windows Vista [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows Server 2003 [デスクトップ アプリのみ | UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | ws2tcpip.h |
| Library | Ws2_32.lib |
| [DLL] | Ws2_32.dll |