Método IMoniker::Enum (objidl.h)

  • Artigo

Recupera um ponteiro para um enumerador para os componentes de um moniker composto.

Sintaxe

HRESULT Enum(
  [in]  BOOL         fForward,
  [out] IEnumMoniker **ppenumMoniker
);

Parâmetros

[in] fForward

Se TRUE, enumera os monikers da esquerda para a direita. Se FALSE, enumera da direita para a esquerda.

[out] ppenumMoniker

Um ponteiro para uma variável de ponteiro IEnumMoniker que recebe o ponteiro de interface para o objeto enumerador para o moniker. Quando bem-sucedida, a implementação deve chamar AddRef no objeto enumerador. É responsabilidade do chamador chamar Release. Se ocorrer um erro ou se o moniker não tiver componentes enumeráveis, a implementação definirá *ppenumMoniker comoNULL.

Retornar valor

Esse método pode retornar os valores retornados padrão E_OUTOFMEMORY, E_UNEXPECTED e S_OK.

Comentários

Esse método deve fornecer um ponteiro IEnumMoniker para um enumerador que pode enumerar os componentes de um moniker. Por exemplo, a implementação do método IMoniker::Enum para um moniker composto genérico cria um enumerador que pode determinar os monikers individuais que compõem a composição, enquanto o método IMoniker::Enum para um moniker de arquivo cria um enumerador que retorna monikers que representam cada um dos componentes no caminho.

Anotações aos Chamadores

Chame esse método para examinar os componentes que compõem um moniker composto.

Observações aos implementadores

Se a nova classe moniker não tiver nenhuma estrutura interna perceptível, sua implementação desse método poderá simplesmente retornar S_OK e definir ppenumMoniker como NULL.

Notas específicas da implementação

Implementação Observações
Anti-moniker Esse método retorna S_OK e define ppenumMoniker comoNULL.
Moniker de classe Esse método retorna S_OK e define ppenumMoniker comoNULL.
Moniker de arquivo Esse método retorna S_OK e define ppenumMoniker comoNULL.
Moniker composto genérico Se tiver êxito, este método retornará S_OK e retornará um enumerador que enumera os monikers de componente que compõem a composição; caso contrário, o método retornará E_OUTOFMEMORY.
Moniker de item Esse método retorna S_OK e define ppenumMoniker comoNULL.
Moniker OBJREF Esse método retorna S_OK e define ppenumMoniker comoNULL.
Moniker de ponteiro Esse método retorna E_NOTIMPL.
Moniker de URL Esse método retorna S_OK e define ppenumMoniker comoNULL.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho objidl.h

Confira também

Ienummoniker

Imoniker