Função MgmGetFirstMfe (mgm.h)

  • Artigo

A função MgmGetFirstMfe recupera MFEs começando no início da lista MFE. A função pode recuperar zero, um ou mais MFEs. O número de MFEs retornados depende do tamanho dos MFEs 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.

Sintaxe

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

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 o 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 MFEs. Cada MFE é uma estrutura MIB_IPMCAST_MFE .

[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 MFEs contidos no pbBuffer.

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 MFE. O cliente deve marcar o valor de pdwBufferSize para o tamanho mínimo do buffer necessário para recuperar um MFE.
ERROR_MORE_DATA
 Mais MFEs estão disponíveis.
ERROR_NO_MORE_ITEMS
 Não há mais MFEs disponíveis. Zero ou mais MFEs foram retornados; marcar o valor de pdwNumEntries para verificar quantos MFEs foram retornados.
 
 

Comentários

Essa função é usada para iniciar a recuperação sequencial de MFEs; use MgmGetNextMfe para continuar o processo de recuperação.

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

Nota O tamanho mínimo do buffer apontado por pbBuffer não é fixo; é diferente para cada MFE. Use a macro sizeof(MIB_IPMCAST_MFE) para determinar o tamanho de cada MFE 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

MgmGetMfe

MgmGetNextMfe