ホーム › NetworkManagement.Multicast › McastEnumerateScopes

McastEnumerateScopes

関数

利用可能なマルチキャストアドレススコープを列挙する。

DLLdhcpcsvc.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// dhcpcsvc.dll
#include <windows.h>

DWORD McastEnumerateScopes(
    WORD AddrFamily,
    BOOL ReQuery,
    MCAST_SCOPE_ENTRY* pScopeList,
    DWORD* pScopeLen,
    DWORD* pScopeCount
);

パラメーター

名前	型	方向	説明
AddrFamily	WORD	in	列挙に使用するアドレスファミリを、 IPNG_ADDRESS 構造体の形式で指定します。IPv4 アドレスの場合は AF_INET を、IPv6 アドレスの場合は AF_INET6 を使用します。
ReQuery	BOOL	in	呼び出し元がリストを再度クエリできるようにします。リストを複数回クエリする場合は、このパラメーターを TRUE に設定します。それ以外の場合は FALSE に設定します。
pScopeList	MCAST_SCOPE_ENTRY*	inout	スコープリスト情報を格納するために使用されるバッファーへのポインターで、 MCAST_SCOPE_ENTRY 構造体の形式です。pScopeList の戻り値は、その入力値と、それが指すバッファーの値によって異なります。入力時に pScopeList が有効なポインターである場合、スコープリストが返されます。入力時に pScopeList が NULL である場合、スコープリストを保持するために必要なバッファーの長さが返されます。入力時に pScopeList が指すバッファーが NULL である場合、 McastEnumerateScopes は MCAST サーバーからのスコープリストの再クエリを強制します。スコープリストデータを保持するために必要なバッファーのサイズを判別するには、pScopeList を NULL に、pScopeLen を NULL 以外の値に設定します。この場合、 McastEnumerateScopes 関数は ERROR_SUCCESS を返し、スコープリストデータのサイズ (バイト単位) を pScopeLen に格納します。
pScopeLen	DWORD*	inout	pScopeList のデータサイズまたはバッファー領域のサイズをやり取りするために使用される値へのポインターです。入力時、pScopeLen は pScopeList が指すバッファーのサイズ (バイト単位) を指します。戻り時、pScopeLen は pScopeList にコピーされたデータのサイズを指します。 pScopeLen パラメーターを NULL にすることはできません。pScopeList が指すバッファーがスコープリストデータを保持するのに十分な大きさでない場合、 McastEnumerateScopes は ERROR_MORE_DATA を返し、必要なバッファーサイズ (バイト単位) を pScopeLen に格納します。スコープリストデータを保持するために必要なバッファーのサイズを判別するには、pScopeList を NULL に、pScopeLen を NULL 以外の値に設定します。この場合、 McastEnumerateScopes 関数は ERROR_SUCCESS を返し、スコープリストデータのサイズ (バイト単位) を pScopeLen に格納します。
pScopeCount	DWORD*	inout	pScopeList に返されたスコープの数へのポインターです。

戻り値の型: DWORD

公式ドキュメント

McastEnumerateScopes 関数は、ネットワーク上で利用可能なマルチキャストスコープを列挙します。

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

pScopeList が指すバッファーがスコープリストを保持するには小さすぎる場合、 McastEnumerateScopes 関数は ERROR_MORE_DATA を返し、必要なバッファーサイズ (バイト単位) を pScopeLen に格納します。

McastApiStartup 関数が呼び出されていない場合 (他の MADCAP クライアント関数を呼び出す前に、この関数を呼び出す必要があります)、 McastEnumerateScopes 関数は ERROR_NOT_READY を返します。

解説(Remarks)

McastEnumerateScopes 関数は、各ネットワークインターフェイスについてマルチキャストスコープをクエリし、スコープが取得されたインターフェイスは pScopeList パラメーターの一部として返されます。そのため、マルチホームコンピューターでは、一部のスコープがインターフェイスごとに 1 回ずつ、複数回リストされる可能性があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// dhcpcsvc.dll
#include <windows.h>

DWORD McastEnumerateScopes(
    WORD AddrFamily,
    BOOL ReQuery,
    MCAST_SCOPE_ENTRY* pScopeList,
    DWORD* pScopeLen,
    DWORD* pScopeCount
);

[DllImport("dhcpcsvc.dll", ExactSpelling = true)]
static extern uint McastEnumerateScopes(
    ushort AddrFamily,   // WORD
    bool ReQuery,   // BOOL
    IntPtr pScopeList,   // MCAST_SCOPE_ENTRY* in/out
    ref uint pScopeLen,   // DWORD* in/out
    ref uint pScopeCount   // DWORD* in/out
);

<DllImport("dhcpcsvc.dll", ExactSpelling:=True)>
Public Shared Function McastEnumerateScopes(
    AddrFamily As UShort,   ' WORD
    ReQuery As Boolean,   ' BOOL
    pScopeList As IntPtr,   ' MCAST_SCOPE_ENTRY* in/out
    ByRef pScopeLen As UInteger,   ' DWORD* in/out
    ByRef pScopeCount As UInteger   ' DWORD* in/out
) As UInteger
End Function

' AddrFamily : WORD
' ReQuery : BOOL
' pScopeList : MCAST_SCOPE_ENTRY* in/out
' pScopeLen : DWORD* in/out
' pScopeCount : DWORD* in/out
Declare PtrSafe Function McastEnumerateScopes Lib "dhcpcsvc" ( _
    ByVal AddrFamily As Integer, _
    ByVal ReQuery As Long, _
    ByVal pScopeList As LongPtr, _
    ByRef pScopeLen As Long, _
    ByRef pScopeCount As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

McastEnumerateScopes = ctypes.windll.dhcpcsvc.McastEnumerateScopes
McastEnumerateScopes.restype = wintypes.DWORD
McastEnumerateScopes.argtypes = [
    ctypes.c_ushort,  # AddrFamily : WORD
    wintypes.BOOL,  # ReQuery : BOOL
    ctypes.c_void_p,  # pScopeList : MCAST_SCOPE_ENTRY* in/out
    ctypes.POINTER(wintypes.DWORD),  # pScopeLen : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # pScopeCount : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dhcpcsvc.dll')
McastEnumerateScopes = Fiddle::Function.new(
  lib['McastEnumerateScopes'],
  [
    -Fiddle::TYPE_SHORT,  # AddrFamily : WORD
    Fiddle::TYPE_INT,  # ReQuery : BOOL
    Fiddle::TYPE_VOIDP,  # pScopeList : MCAST_SCOPE_ENTRY* in/out
    Fiddle::TYPE_VOIDP,  # pScopeLen : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # pScopeCount : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpcsvc")]
extern "system" {
    fn McastEnumerateScopes(
        AddrFamily: u16,  // WORD
        ReQuery: i32,  // BOOL
        pScopeList: *mut MCAST_SCOPE_ENTRY,  // MCAST_SCOPE_ENTRY* in/out
        pScopeLen: *mut u32,  // DWORD* in/out
        pScopeCount: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dhcpcsvc.dll")]
public static extern uint McastEnumerateScopes(ushort AddrFamily, bool ReQuery, IntPtr pScopeList, ref uint pScopeLen, ref uint pScopeCount);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dhcpcsvc_McastEnumerateScopes' -Namespace Win32 -PassThru
# $api::McastEnumerateScopes(AddrFamily, ReQuery, pScopeList, pScopeLen, pScopeCount)

#uselib "dhcpcsvc.dll"
#func global McastEnumerateScopes "McastEnumerateScopes" sptr, sptr, sptr, sptr, sptr
; McastEnumerateScopes AddrFamily, ReQuery, varptr(pScopeList), varptr(pScopeLen), varptr(pScopeCount)   ; 戻り値は stat
; AddrFamily : WORD -> "sptr"
; ReQuery : BOOL -> "sptr"
; pScopeList : MCAST_SCOPE_ENTRY* in/out -> "sptr"
; pScopeLen : DWORD* in/out -> "sptr"
; pScopeCount : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dhcpcsvc.dll"
#cfunc global McastEnumerateScopes "McastEnumerateScopes" int, int, var, var, var
; res = McastEnumerateScopes(AddrFamily, ReQuery, pScopeList, pScopeLen, pScopeCount)
; AddrFamily : WORD -> "int"
; ReQuery : BOOL -> "int"
; pScopeList : MCAST_SCOPE_ENTRY* in/out -> "var"
; pScopeLen : DWORD* in/out -> "var"
; pScopeCount : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dhcpcsvc.dll"
#cfunc global McastEnumerateScopes "McastEnumerateScopes" int, int, sptr, sptr, sptr
; res = McastEnumerateScopes(AddrFamily, ReQuery, varptr(pScopeList), varptr(pScopeLen), varptr(pScopeCount))
; AddrFamily : WORD -> "int"
; ReQuery : BOOL -> "int"
; pScopeList : MCAST_SCOPE_ENTRY* in/out -> "sptr"
; pScopeLen : DWORD* in/out -> "sptr"
; pScopeCount : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。