Fonction MgmGetFirstMfeStats (mgm.h)
La fonction MgmGetFirstMfeStats récupère les statistiques MFE en commençant au début de la liste MFE. La fonction peut récupérer zéro, un ou plusieurs ensembles de statistiques MFE. Le nombre de jeux retournés dépend de la taille des entrées et de la taille de la mémoire tampon fournie par le client lorsque la fonction est appelée.
Les données retournées dans la mémoire tampon sont d’abord triées par groupe, puis par les sources au sein d’un groupe. Les statistiques retournées incluent les paquets reçus, les octets reçus et les paquets transférés sur chaque interface sortante.
Syntaxe
DWORD MgmGetFirstMfeStats(
[in, out] PDWORD pdwBufferSize,
[in, out] PBYTE pbBuffer,
[in, out] PDWORD pdwNumEntries,
DWORD dwFlags
);
Paramètres
[in, out] pdwBufferSize
En entrée, pdwBufferSize est un pointeur vers un emplacement mémoire de taille DWORD contenant la taille, en octets, de pbBuffer.
En sortie, si la valeur de retour est ERROR_INSUFFICIENT_BUFFER, pdwBufferSize reçoit la taille minimale pbBuffer doit être pour contenir un ensemble de statistiques MFE ; sinon, la valeur de pdwBufferSize reste inchangée.
[in, out] pbBuffer
Lors de l’entrée, le client doit fournir un pointeur vers une mémoire tampon.
Sur la sortie, pbBuffer contient un ou plusieurs ensembles de statistiques MFE. Chaque ensemble de statistiques MFE est une structure MIB_IPMCAST_MFE_STATS .
[in, out] pdwNumEntries
Lors de l’entrée, le client doit fournir un pointeur vers un emplacement mémoire de taille DWORD.
À la sortie, pdwNumEntries reçoit le nombre d’ensembles de statistiques MFE contenues dans pbBuffer.
dwFlags
Détermine la structure de données retournée.
| Valeur | Signification |
|---|---|
|
Incluez des statistiques correspondant à MIB_IPMCAST_MFE_STATS. |
|
Incluez les statistiques correspondant à MIB_IPMCAST_MFE_STATS_EX. |
Valeur retournée
Si la fonction réussit, la valeur de retour est NO_ERROR.
Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.
| Valeur | Signification |
|---|---|
|
Impossible de terminer l’appel à cette fonction. |
|
La mémoire tampon spécifiée est trop petite pour même un ensemble de statistiques MFE. Le client doit case activée la valeur de pdwBufferSize pour la taille de mémoire tampon minimale requise pour récupérer un ensemble de statistiques. |
|
D’autres statistiques MFE sont disponibles. |
|
Il n’y a plus de statistiques MFE disponibles. Un ou plusieurs ensembles de statistiques MFE ont été retournés ; case activée la valeur de pdwNumEntries pour vérifier le nombre de jeux de statistiques retournés. |
Remarques
Cette fonction est utilisée pour commencer la récupération séquentielle des statistiques MFE ; utilisez MgmGetNextMfeStats pour poursuivre le processus de récupération.
En général, pour récupérer des statistiques MFE, appelez d’abord MgmGetFirstMfeStats. Ensuite, appelez MgmGetNextMfeStats une ou plusieurs fois, jusqu’à ce qu’il n’y ait plus de MFP à retourner. Chaque appel à MgmGetNextMfeStats doit commencer après le dernier MFE retourné par l’appel précédent à MgmGetNextMfeStats (ou l’appel initial à MgmGetFirstMfeStats) Pour ce faire, le client spécifie la dernière source et le dernier groupe dans la mémoire tampon retournée par un appel précédent.
Les statistiques MFE sont retournées dans une structure MIB_IPMCAST_MFE_STATS ou MIB_IPMCAST_MFE_STATS_EX déterminée par le paramètre dwFlags .
Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Aucun pris en charge |
| Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | mgm.h |
| Bibliothèque | Rtm.lib |
| DLL | Rtm.dll |