IMAPISession::OpenAddressBook

Artigo
04/04/2023

Aplica-se a: Outlook 2013 | Outlook 2016

Abre o catálogo de endereços integrado mapi, retornando um ponteiro IAddrBook para obter mais acesso.

HRESULT OpenAddressBook(
  ULONG_PTR ulUIParam,
  LPCIID lpInterface,
  ULONG ulFlags,
  LPADRBOOK FAR * lppAdrBook
);

Parâmetros

ulUIParam

[in] Um identificador para a janela pai da caixa de diálogo endereço comum e outras exibições relacionadas.

lpInterface

[in] Um ponteiro para o IID (identificador de interface) que representa a interface a ser usada para acessar o catálogo de endereços. Passar nulo retorna um ponteiro para a interface padrão do catálogo de endereços, IAddrBook : IMAPIProp.

ulFlags

[in] Um bitmask de sinalizadores que controla a abertura do catálogo de endereços. O seguinte sinalizador pode ser definido:

AB_NO_DIALOG

Suprime a exibição de caixas de diálogo. Se o sinalizador AB_NO_DIALOG não estiver definido, os provedores de catálogo de endereços que contribuem para o catálogo de endereços integrado poderão solicitar ao usuário qualquer informação necessária.

lppAdrBook

[out] Um ponteiro para um ponteiro para o catálogo de endereços.

Valor de retorno

S_OK

O catálogo de endereços foi aberto com êxito.

MAPI_W_ERRORS_RETURNED

A chamada foi bem-sucedida, mas os contêineres de um ou mais provedores de catálogo de endereços não puderam ser abertos. Quando esse aviso é retornado, a chamada deve ser tratada como bem-sucedida. Para testar esse aviso, use a macro HR_FAILED . Para obter mais informações, confira Usando macros para tratamento de erros.

Comentários

O método IMAPISession::OpenAddressBook abre o catálogo de endereços integrado mapi, uma coleção dos contêineres de nível superior de todos os provedores de catálogo de endereços no perfil. O ponteiro retornado no parâmetro lppAdrBook fornece acesso adicional ao conteúdo do catálogo de endereços. Isso permite que o chamador execute tarefas como abrir contêineres individuais, localizar usuários de mensagens e exibir caixas de diálogo de endereço comuns.

Notas para chamadores

OpenAddressBook retornará MAPI_W_ERRORS_RETURNED se não puder carregar um ou mais provedores de catálogo de endereços no perfil. Esse valor é um aviso, não um valor de erro; manipule-o como você S_OK. OpenAddressBook sempre retorna um ponteiro válido no parâmetro lppAdrBook , independentemente de quantos provedores de catálogo de endereços não foram carregados. Portanto, você deve sempre chamar o método IUnknown::Release do catálogo de endereços em algum momento antes de fazer logon.

Quando OpenAddressBook retornar MAPI_W_ERRORS_RETURNED, chame IMAPISession::GetLastError para obter uma estrutura MAPIERROR que contenha informações sobre os provedores com falha. Uma única estrutura MAPIERROR é retornada que contém informações fornecidas por todos os provedores.