Função MgmGetFirstMfeStats (mgm.h)

A função MgmGetFirstMfeStats recupera estatísticas de MFE começando no início da lista MFE. A função pode recuperar zero, um ou mais conjuntos de estatísticas MFE. O número de conjuntos retornados depende do tamanho das entradas e do tamanho do buffer fornecido pelo cliente quando a função é chamada.

Os dados retornados no buffer são ordenados primeiro por grupo e, em seguida, pelas fontes dentro de um grupo. As estatísticas retornadas incluem os pacotes recebidos, os bytes recebidos e os pacotes encaminhados em cada interface de saída.

Sintaxe

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

Parâmetros

[in, out] pdwBufferSize

Na entrada, pdwBufferSize é um ponteiro para um local de memória do tamanho DWORD que contém o tamanho, em bytes, de pbBuffer.

Na saída, se o valor retornado for ERROR_INSUFFICIENT_BUFFER, pdwBufferSize receberá o tamanho mínimo que pbBuffer deve ser para manter um conjunto de estatísticas MFE; caso contrário, o valor de pdwBufferSize permanecerá inalterado.

[in, out] pbBuffer

Na entrada, o cliente deve fornecer um ponteiro para um buffer.

Na saída, pbBuffer contém um ou mais conjuntos de estatísticas MFE. Cada conjunto de estatísticas de MFE é uma estrutura MIB_IPMCAST_MFE_STATS .

[in, out] pdwNumEntries

Na entrada, o cliente deve fornecer um ponteiro para um local de memória do tamanho DWORD.

Na saída, pdwNumEntries recebe o número de conjuntos de estatísticas MFE contidas no pbBuffer.

dwFlags

Determina a estrutura de dados retornada.

Valor Significado
MGM_MFE_STATS_0
Inclua estatísticas correspondentes a MIB_IPMCAST_MFE_STATS.
MGM_MFE_STATS_1
Inclua estatísticas correspondentes a MIB_IPMCAST_MFE_STATS_EX.

Retornar valor

Se a função for bem-sucedida, o valor retornado será NO_ERROR.

Se a função falhar, o valor retornado será um dos seguintes códigos de erro.

Valor Significado
ERROR_CAN_NOT_COMPLETE
Não foi possível concluir a chamada para essa função.
ERROR_INSUFFICIENT_BUFFER
O buffer especificado é muito pequeno para até mesmo um conjunto de estatísticas de MFE. O cliente deve marcar o valor de pdwBufferSize para o tamanho mínimo do buffer necessário para recuperar um conjunto de estatísticas.
ERROR_MORE_DATA
Mais estatísticas de MFE estão disponíveis.
ERROR_NO_MORE_ITEMS
Não há mais estatísticas de MFE disponíveis. Zero ou mais conjuntos de estatísticas MFE foram retornados; marcar o valor de pdwNumEntries para verificar quantos conjuntos de estatísticas foram retornados.

Comentários

Essa função é usada para iniciar a recuperação sequencial de estatísticas de MFE; use MgmGetNextMfeStats para continuar o processo de recuperação.

Em geral, para recuperar estatísticas de MFE, primeiro chame MgmGetFirstMfeStats. Em seguida, chame MgmGetNextMfeStats uma ou mais vezes, até que não haja mais MFEs para retornar. Cada chamada para MgmGetNextMfeStats deve começar após o último MFE retornado pela chamada anterior para MgmGetNextMfeStats (ou a chamada inicial para MgmGetFirstMfeStats) Para fazer isso, o cliente especifica a última origem e o grupo no buffer retornado por uma chamada anterior.

As estatísticas de MFE são retornadas em uma estrutura de MIB_IPMCAST_MFE_STATS ou MIB_IPMCAST_MFE_STATS_EX determinada pelo parâmetro dwFlags .

Nota O tamanho mínimo do buffer apontado por pbBuffer não é fixo; é diferente para cada conjunto de estatísticas de MFE. Use a macro sizeof para determinar o tamanho de cada conjunto de estatísticas retornado no buffer.
 

Requisitos

Requisito Valor
Cliente mínimo com suporte Nenhum compatível
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho mgm.h
Biblioteca Rtm.lib
DLL Rtm.dll

Confira também

MIB_IPMCAST_MFE_STATS

MIB_IPMCAST_MFE_STATS_EX

MgmGetMfeStats

MgmGetNextMfeStats