Função MgmGroupEnumerationStart (mgm.h)

  • Artigo

A função MgmGroupEnumerationStart obtém um identificador de enumeração usado posteriormente para obter a lista de grupos que foram ingressados. Depois que o cliente obtém o identificador, ele deve usar a função MgmGroupEnumerationGetNext para enumerar os grupos.

Sintaxe

DWORD MgmGroupEnumerationStart(
  [in]  HANDLE         hProtocol,
  [in]  MGM_ENUM_TYPES metEnumType,
  [out] HANDLE         *phEnumHandle
);

Parâmetros

[in] hProtocol

Manipule para o protocolo obtido de uma chamada anterior para MgmRegisterMProtocol.

[in] metEnumType

Especifica o tipo de enumeração. As enumerações a seguir estão disponíveis.

Enumeração Significado
ALL_SOURCES
 Recupera junções curinga (*, g) e junções específicas da origem (s, g).
ANY_SOURCE
 Recupera entradas de grupo que têm pelo menos uma origem especificada.

[out] phEnumHandle

Recebe o identificador para a enumeração. Use esse identificador em chamadas para MgmGroupEnumerationGetNext e MgmGroupEnumerationEnd.

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_INVALID_PARAMETER
 Identificador inválido para um protocolo.
ERROR_NOT_ENOUGH_MEMORY
 Memória insuficiente para concluir esta operação.
 
 

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

MGM_ENUM_TYPES

MgmGroupEnumerationEnd

MgmGroupEnumerationGetNext