Freigeben über


MgmGetFirstMfeStats-Funktion (mgm.h)

Die MgmGetFirstMfeStats-Funktion ruft MFE-Statistiken ab dem Anfang der MFE-Liste ab. Die Funktion kann null, einen oder mehrere Sätze von MFE-Statistiken abrufen. Die Anzahl der zurückgegebenen Sätze hängt von der Größe der Einträge und der Größe des Puffers ab, der vom Client bereitgestellt wird, wenn die Funktion aufgerufen wird.

Die im Puffer zurückgegebenen Daten werden zuerst nach Gruppe und dann nach den Quellen innerhalb einer Gruppe sortiert. Die zurückgegebenen Statistiken umfassen die empfangenen Pakete, empfangenen Bytes und Pakete, die auf jeder ausgehenden Schnittstelle weitergeleitet werden.

Syntax

DWORD MgmGetFirstMfeStats(
  [in, out] PDWORD pdwBufferSize,
  [in, out] PBYTE  pbBuffer,
  [in, out] PDWORD pdwNumEntries,
            DWORD  dwFlags
);

Parameter

[in, out] pdwBufferSize

Bei der Eingabe ist pdwBufferSize ein Zeiger auf einen Speicherspeicherort in DWORD-Größe, der die Größe von pbBuffer in Bytes enthält.

Wenn der Rückgabewert in der Ausgabe ERROR_INSUFFICIENT_BUFFER ist, empfängt pdwBufferSize die Mindestgröße pbBuffer , um eine Reihe von MFE-Statistiken zu enthalten; andernfalls bleibt der Wert von pdwBufferSize unverändert.

[in, out] pbBuffer

Bei der Eingabe muss der Client einen Zeiger auf einen Puffer bereitstellen.

PbBuffer enthält bei der Ausgabe einen oder mehrere Sätze von MFE-Statistiken. Jeder Satz von MFE-Statistiken ist eine MIB_IPMCAST_MFE_STATS Struktur.

[in, out] pdwNumEntries

Bei der Eingabe muss der Client einen Zeiger auf einen Speicherspeicherort im DWORD-Format bereitstellen.

Bei der Ausgabe empfängt pdwNumEntries die Anzahl von Sätzen von MFE-Statistiken, die in pbBuffer enthalten sind.

dwFlags

Bestimmt die zurückgegebene Datenstruktur.

Wert Bedeutung
MGM_MFE_STATS_0
Fügen Sie Statistiken ein, die MIB_IPMCAST_MFE_STATS entsprechen.
MGM_MFE_STATS_1
Fügen Sie Statistiken ein, die MIB_IPMCAST_MFE_STATS_EX entsprechen.

Rückgabewert

Wenn die Funktion erfolgreich ist, wird der Rückgabewert NO_ERROR.

Wenn die Funktion fehlschlägt, ist der Rückgabewert einer der folgenden Fehlercodes.

Wert Bedeutung
ERROR_CAN_NOT_COMPLETE
Der Aufruf dieser Funktion konnte nicht abgeschlossen werden.
ERROR_INSUFFICIENT_BUFFER
Der angegebene Puffer ist zu klein für nur einen Satz MFE-Statistiken. Der Client sollte den Wert von pdwBufferSize auf die minimale Puffergröße überprüfen, die zum Abrufen eines Statistiksatzes erforderlich ist.
ERROR_MORE_DATA
Weitere MFE-Statistiken sind verfügbar.
ERROR_NO_MORE_ITEMS
Es sind keine weiteren MFE-Statistiken verfügbar. Es wurden null oder mehr Sätze von MFE-Statistiken zurückgegeben. Überprüfen Sie den Wert von pdwNumEntries , um zu überprüfen, wie viele Statistiken zurückgegeben wurden.

Hinweise

Diese Funktion wird verwendet, um mit dem sequenziellen Abruf von MFE-Statistiken zu beginnen. Verwenden Sie MgmGetNextMfeStats , um den Abrufvorgang fortzusetzen.

Zum Abrufen von MFE-Statistiken rufen Sie im Allgemeinen zuerst MgmGetFirstMfeStats auf. Rufen Sie dann MgmGetNextMfeStats ein oder mehrere Male auf, bis keine MFEs mehr zurückgegeben werden können. Jeder Aufruf von MgmGetNextMfeStats sollte nach dem letzten MFE beginnen, der vom vorherigen Aufruf von MgmGetNextMfeStats (oder dem ersten Aufruf von MgmGetFirstMfeStats) zurückgegeben wurde. Hierzu gibt der Client die letzte Quelle und Gruppe im Puffer an, die von einem vorherigen Aufruf zurückgegeben wurden.

Die MFE-Statistiken werden entweder in einer MIB_IPMCAST_MFE_STATS oder MIB_IPMCAST_MFE_STATS_EX Struktur zurückgegeben, die vom dwFlags-Parameter bestimmt wird.

Hinweis Die Mindestgröße des Puffers, auf den pbBuffer verweist, ist nicht festgelegt. Sie unterscheidet sich für jeden Satz von MFE-Statistiken. Verwenden Sie das Makro sizeof , um die Größe der einzelnen im Puffer zurückgegebenen Statistiken zu bestimmen.
 

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Nicht unterstützt
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile mgm.h
Bibliothek Rtm.lib
DLL Rtm.dll

Weitere Informationen

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetMfeStats

MgmGetNextMfeStats