MgmGetFirstMfe-Funktion (mgm.h)

Artikel
08/24/2023

Die MgmGetFirstMfe-Funktion ruft MFEs ab dem Anfang der MFE-Liste ab. Die Funktion kann null, ein oder mehrere MFEs abrufen. Die Anzahl der zurückgegebenen MFEs hängt von der Größe der MFEs 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.

Syntax

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

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 die MFE enthalten zu können; 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 mindestens ein MFEs. Jede MFE ist eine MIB_IPMCAST_MFE 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 der in pbBuffer enthaltenen MFEs.

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 für nur eine MFE zu klein. Der Client sollte den Wert von pdwBufferSize auf die minimale Puffergröße überprüfen, die zum Abrufen einer MFE erforderlich ist.
ERROR_MORE_DATA	Weitere MFEs sind verfügbar.
ERROR_NO_MORE_ITEMS	Es sind keine mfEs mehr verfügbar. Es wurden null oder mehr MFEs zurückgegeben. Überprüfen Sie den Wert von pdwNumEntries , um zu überprüfen, wie viele MFEs zurückgegeben wurden.

Hinweise

Diese Funktion wird verwendet, um mit dem sequenziellen Abruf von MFEs zu beginnen. Verwenden Sie MgmGetNextMfe , um den Abrufvorgang fortzusetzen.

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

Hinweis Die Mindestgröße des Puffers, auf den pbBuffer verweist, ist nicht festgelegt. sie ist für jeden MFE unterschiedlich. Verwenden Sie das Makro sizeof(MIB_IPMCAST_MFE), um die Größe der einzelnen MFE-Elemente zu bestimmen, die im Puffer zurückgegeben werden.

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

MgmGetMfe

MgmGetNextMfe

Freigeben über