IAddrBook::GetSearchPath
Aplica-se a: Outlook 2013 | Outlook 2016
Retorna uma lista ordenada de identificadores de entrada dos contêineres a serem incluídos no processo de resolução de nomes iniciado pelo método IAddrBook::ResolveName .
HRESULT GetSearchPath(
ULONG ulFlags,
LPSRowSet FAR * lppSearchPath
);
Parâmetros
ulFlags
[in] Um bitmask de sinalizadores que controla o tipo das cadeias de caracteres retornadas no caminho de pesquisa. O seguinte sinalizador pode ser definido:
MAPI_UNICODE
As cadeias de caracteres retornadas estão no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, as cadeias de caracteres estarão no formato ANSI.
lppSearchPath
[out] Um ponteiro para um ponteiro para uma lista ordenada de identificadores de entrada de contêiner. O GetSearchPath armazena a lista ordenada em uma estrutura SRowSet . Se não houver contêineres na hierarquia do catálogo de endereços, zero será retornado na estrutura SRowSet .
Valor de retorno
S_OK
O caminho de pesquisa foi recuperado com êxito.
Comentários
Clientes e provedores de serviços chamam o método GetSearchPath para obter o caminho de pesquisa usado para resolve nomes com o método ResolveName. Normalmente, os clientes chamam o método IAddrBook::SetSearchPath para estabelecer um caminho de pesquisa de contêiner no perfil antes de chamar GetSearchPath para recuperá-lo. No entanto, chamar SetSearchPath é opcional.
Se SetSearchPath nunca tiver sido chamado, GetSearchPath criará um caminho trabalhando através das tabelas de hierarquia do catálogo de endereços. O caminho de pesquisa padrão estabelecido pelo GetSearchPath consiste nos seguintes contêineres na seguinte ordem:
O primeiro contêiner com permissão de leitura/gravação, geralmente o PAB (catálogo de endereços pessoal).
Cada contêiner que tem sua propriedade PR_DISPLAY_TYPE (PidTagDisplayType) definida como DT_GLOBAL. Essa configuração indica que o contêiner contém destinatários.
O contêiner designado como padrão, se não houver contêineres que tenham o sinalizador DT_GLOBAL definido em sua propriedade PR_DISPLAY_TYPE e o contêiner padrão for diferente do primeiro contêiner com permissão de leitura/gravação.
Se SetSearchPath tiver sido chamado, GetSearchPath criará um caminho usando os contêineres do catálogo de endereços armazenados no perfil. GetSearchPath valida esse caminho antes de retornar ao chamador.
Após a primeira chamada para SetSearchPath, as chamadas subsequentes para SetSearchPath devem ser usadas para modificar o caminho de pesquisa retornado pelo GetSearchPath. Em outras palavras, o cliente ou provedor de chamada não recebe o caminho de pesquisa padrão após a primeira chamada para SetSearchPath.