Función MgmGetFirstMfeStats (mgm.h)

  • Artículo

La función MgmGetFirstMfeStats recupera las estadísticas de MFE a partir del principio de la lista de MFE. La función puede recuperar cero, uno o varios conjuntos de estadísticas de MFE. El número de conjuntos devueltos depende del tamaño de las entradas y del tamaño del búfer proporcionado por el cliente cuando se llama a la función.

Los datos devueltos en el búfer se ordenan primero por grupo y, a continuación, por los orígenes de un grupo. Las estadísticas devueltas incluyen los paquetes recibidos, bytes recibidos y paquetes reenviados en cada interfaz saliente.

Sintaxis

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

Parámetros

[in, out] pdwBufferSize

En la entrada, pdwBufferSize es un puntero a una ubicación de memoria de tamaño DWORD que contiene el tamaño, en bytes, de pbBuffer.

En la salida, si el valor devuelto es ERROR_INSUFFICIENT_BUFFER, pdwBufferSize recibe el tamaño mínimo pbBuffer debe contener un conjunto de estadísticas de MFE; de lo contrario, el valor de pdwBufferSize permanece sin cambios.

[in, out] pbBuffer

En la entrada, el cliente debe proporcionar un puntero a un búfer.

En la salida, pbBuffer contiene uno o varios conjuntos de estadísticas de MFE. Cada conjunto de estadísticas de MFE es una estructura MIB_IPMCAST_MFE_STATS .

[in, out] pdwNumEntries

En la entrada, el cliente debe proporcionar un puntero a una ubicación de memoria de tamaño DWORD.

En la salida, pdwNumEntries recibe el número de conjuntos de estadísticas de MFE contenidas en pbBuffer.

dwFlags

Determina la estructura de datos devuelta.

Valor Significado
MGM_MFE_STATS_0
 Incluya estadísticas correspondientes a MIB_IPMCAST_MFE_STATS.
MGM_MFE_STATS_1
 Incluya estadísticas correspondientes a MIB_IPMCAST_MFE_STATS_EX.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Valor Significado
ERROR_CAN_NOT_COMPLETE
 No se pudo completar la llamada a esta función.
ERROR_INSUFFICIENT_BUFFER
 El búfer especificado es demasiado pequeño para incluso un conjunto de estadísticas de MFE. El cliente debe comprobar el valor de pdwBufferSize para el tamaño mínimo del búfer necesario para recuperar un conjunto de estadísticas.
ERROR_MORE_DATA
 Hay más estadísticas de MFE disponibles.
ERROR_NO_MORE_ITEMS
 No hay más estadísticas de MFE disponibles. Se devolvieron cero o más conjuntos de estadísticas de MFE; compruebe el valor de pdwNumEntries para comprobar cuántos conjuntos de estadísticas se devolvieron.

Comentarios

Esta función se usa para comenzar la recuperación secuencial de las estadísticas de MFE; use MgmGetNextMfeStats para continuar el proceso de recuperación.

En general, para recuperar las estadísticas de MFE, llame primero a MgmGetFirstMfeStats. A continuación, llame a MgmGetNextMfeStats una o varias veces, hasta que no haya más MFE para devolver. Cada llamada a MgmGetNextMfeStats debe comenzar después de la última MFE devuelta por la llamada anterior a MgmGetNextMfeStats (o la llamada inicial a MgmGetFirstMfeStats) Para ello, el cliente especifica el último origen y grupo en el búfer devuelto por una llamada anterior.

Las estadísticas de MFE se devuelven en una estructura MIB_IPMCAST_MFE_STATS o MIB_IPMCAST_MFE_STATS_EX determinada por el parámetro dwFlags .

Nota El tamaño mínimo del búfer al que apunta pbBuffer no es fijo; es diferente para cada conjunto de estadísticas de MFE. Use la macro sizeof para determinar el tamaño de cada conjunto de estadísticas devuelta en el búfer.
 

Requisitos

Requisito Value
Cliente mínimo compatible No se admite ninguno
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado mgm.h
Library Rtm.lib
Archivo DLL Rtm.dll

Consulte también

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetMfeStats

MgmGetNextMfeStats