GetMulticastIpAddressTable függvény

A GetMulticastIpAddressTable függvény lekéri a csoportos küldésű IP-címtáblát egy helyi számítógépen.

Szintaxis

NETIOAPI_API GetMulticastIpAddressTable(
  _In_  ADDRESS_FAMILY                Family,
  _Out_ PMIB_MULTICASTIPADDRESS_TABLE *Table
);

Paraméterek

• Családi [in]
  A lekérendő címcsalád.

  A címcsalád lehetséges értékei a Winsock2.h fejlécfájlban jelennek meg. Vegye figyelembe, hogy a AF_ címcsalád és PF_ protokollcsalád állandói azonosak (például AF_INET és PF_INET), így bármelyik állandót használhatja.

  A Windows Vista és a Windows operációs rendszerek újabb verzióiban a Family paraméter lehetséges értékei a Ws2def.h fejlécfájlban vannak definiálva. Vegye figyelembe, hogy a Ws2def.h fejlécfájl automatikusan szerepel a Netioapi.h-ban, és soha ne használja közvetlenül a Ws2def.h fájlt.

  A címcsalád esetében jelenleg a következő értékek támogatottak:

  • AF_INET
    Az IPv4-címcsalád. Ha ez az érték meg van adva, ez a függvény azt a csoportos küldésű IP-címtáblát adja vissza, amely csak IPv4-bejegyzéseket tartalmaz.

  • AF_INET6
    Az IPv6-címcsalád. Ha ez az érték meg van adva, ez a függvény azt a csoportos küldésű IP-címtáblát adja vissza, amely csak IPv6-bejegyzéseket tartalmaz.

  • AF_UNSPEC
    A címcsalád nincs meghatározva. Ha ez az érték meg van adva, ez a függvény az IPv4- és IPv6-bejegyzéseket egyaránt tartalmazó csoportos küldésű IP-címtáblát adja vissza.

• tábla [ki]
  Mutató egy MIB_MULTICASTIPADDRESS_TABLE struktúrára, amely a helyi számítógépen található ip-címbejegyzések táblázatát tartalmazza.

Visszaadott érték

GetMulticastIpAddressTable a függvény sikeres működése esetén STATUS_SUCCESS ad vissza.

Ha a függvény meghiúsul, GetMulticastIpAddressTable a következő hibakódok egyikét adja vissza:

Kód visszaadása	Leírás
STATUS_INVALID_PARAMETER	Érvénytelen paraméter lett átadva a függvénynek. Ez a hiba akkor jelenik meg, ha NULL mutatót ad át a Tábla paraméterben, vagy a Családi paraméter nincs megadva AF_INET, AF_INET6 vagy AF_UNSPEC.
STATUS_NOT_ENOUGH_MEMORY	A művelet végrehajtásához nincs elegendő memóriaerőforrás.
STATUS_NOT_FOUND	A Családi paraméterben megadott ip-címbejegyzések nem találhatók.
STATUS_NOT_SUPPORTED	A kérés nem támogatott. Ez a hiba akkor jelenik meg, ha nem található IPv4-verem a helyi számítógépen, és AF_INET a Családi paraméterben van megadva, vagy ha nem található IPv6-verem a helyi számítógépen, és AF_INET6 a Családi paraméterben van megadva. Ez a hiba a Windows azon verzióiban is megjelenik, ahol ez a függvény nem támogatott.
Egyéb	A FormatMessage függvénnyel szerezze be a visszaadott hiba üzenetsztringét.

Megjegyzések

A GetMulticastIpAddressTable függvény számba adja a helyi számítógépen található csoportos küldési IP-címeket, és ezt az információt egy MIB_MULTICASTIPADDRESS_TABLE struktúrában adja vissza.

GetMulticastIpAddressTable egy MIB_MULTICASTIPADDRESS_TABLE struktúrában lévő csoportos küldési IP-címbejegyzéseket ad vissza, amelyekre a Tábla paraméter mutat. A MIB_MULTICASTIPADDRESS_TABLE struktúra tartalmazza a csoportos küldésű IP-címek bejegyzéseinek számát és az egyes csoportos küldésű IP-címbejegyzések MIB_MULTICASTIPADDRESS_ROW struktúráinak tömbét. Ha ezekre a visszaadott struktúrákra már nincs szükség, az illesztőprogramnak szabadíthatja fel a memóriát FreeMibTablemeghívásával.

Az illesztőprogramnak inicializálnia kell a Családi paramétert AF_INET, AF_INET6 vagy AF_UNSPEC.

Vegye figyelembe, hogy a visszaadott MIB_MULTICASTIPADDRESS_TABLE struktúra, amelyre a Tábla paraméter mutat, tartalmazhat a NumEntries tag és a Tábla MIB_MULTICASTIPADDRESS_TABLE-szerkezet első MIB_MULTICASTIPADDRESS_ROW tömbbejegyzése közötti igazításhoz. Előfordulhat, hogy a MIB_MULTICASTIPADDRESS_ROW tömbbejegyzések között is van párnázás az igazításhoz. Egy MIB_MULTICASTIPADDRESS_ROW tömbbejegyzéshez való hozzáférés feltételezi, hogy a kitöltés létezhet.

Követelmények

Célplatform	Univerzális
Verzió	Elérhető a Windows Vista és a Windows operációs rendszerek újabb verzióiban.
Fejléc	Netioapi.h (netioapi.h)
Könyvtár	Netio.lib
IRQL	< DISPATCH_LEVEL

Lásd még:

GetMulticastIpAddressEntry

MIB_MULTICASTIPADDRESS_ROW

MIB_MULTICASTIPADDRESS_TABLE