Função de retorno de chamada MAPIDETAILS (mapi.h)

Artigo
03/09/2023

[O uso dessa função é desencorajado. Ele pode estar alterado ou indisponível nas versões subsequentes do Windows.]

A função MAPIDetails exibe uma caixa de diálogo que contém os detalhes de uma entrada de lista de endereços selecionada.

Sintaxe

MAPIDETAILS Mapidetails;

ULONG Mapidetails(
  [in] LHANDLE lhSession,
  [in] ULONG_PTR ulUIParam,
  [in] lpMapiRecipDesc lpRecip,
  [in] FLAGS flFlags,
       ULONG ulReserved
)
{...}

Parâmetros

[in] lhSession

Identificador de sessão que representa uma sessão MAPI simples ou zero. Se o valor do parâmetro lhSession for zero, MAPI faz logon no usuário e cria uma sessão que existe apenas durante a chamada. Essa sessão temporária pode ser uma sessão compartilhada existente ou uma nova. Se forem necessárias informações adicionais do usuário para concluir o logon com êxito, uma caixa de diálogo será exibida.

[in] ulUIParam

Identificador de janela pai ou zero, indicando que, se uma caixa de diálogo for exibida, ela será modal do aplicativo. Se o parâmetro ulUIParam contiver um identificador de janela pai, ele será do tipo HWND (convertido em um ULONG_PTR). Se nenhuma caixa de diálogo for exibida durante a chamada, ulUIParam será ignorado.

[in] lpRecip

Ponteiro para o destinatário para o qual os detalhes devem ser exibidos. MAPIDetails ignora todos os membros dessa estrutura MapiRecipDesc , exceto os membros ulEIDSize e lpEntryID . Se o valor de ulEIDSize for diferente de zero, MAPIDetails resolverá a entrada do destinatário. Se o valor de ulEIDSize for zero, MAPIDetails retornará o valor MAPI_E_AMBIGUOUS_RECIP.

[in] flFlags

Máscara de bits de sinalizadores de opção. Os sinalizadores a seguir podem ser definidos.

Valor	Significado
MAPI_AB_NOMODIFY	O chamador está solicitando que a caixa de diálogo seja somente leitura, proibindo alterações. MAPIDetails pode ou não atender à solicitação.
MAPI_LOGON_UI	Uma caixa de diálogo deve ser exibida para solicitar que o usuário faça logon, se necessário. Quando o sinalizador MAPI_LOGON_UI não estiver definido, o aplicativo cliente não exibirá uma caixa de diálogo de logon e retornará um valor de erro se o usuário não estiver conectado.
MAPI_NEW_SESSION	Uma tentativa deve ser feita para criar uma nova sessão em vez de adquirir a sessão compartilhada do ambiente. Se o sinalizador MAPI_NEW_SESSION não estiver definido, MAPIDetails usará uma sessão compartilhada existente.

ulReserved

Reservados; deve ser zero.

Valor retornado

Essa função retorna um dos valores a seguir.

Código de retorno	Descrição
MAPI_E_AMBIGUOUS_RECIPIENT	Não foi possível exibir a caixa de diálogo porque o membro ulEIDSize da estrutura apontada pelo parâmetro lpRecips era zero.
MAPI_E_FAILURE	Ocorreu um ou mais erros não especificados. Nenhuma caixa de diálogo foi exibida.
MAPI_E_INSUFFICIENT_MEMORY	Não havia memória suficiente para continuar. Nenhuma caixa de diálogo foi exibida.
MAPI_E_INVALID_RECIPS	O destinatário especificado no parâmetro lpRecip era desconhecido ou o destinatário tinha um valor ulEIDSize inválido. Nenhuma caixa de diálogo foi exibida.
MAPI_E_LOGIN_FAILURE	Não havia nenhum logon padrão e o usuário não conseguiu fazer logon com êxito quando a caixa de diálogo de logon foi exibida. Nenhuma caixa de diálogo foi exibida.
MAPI_E_NOT_SUPPORTED	A operação não era compatível com o sistema de mensagens subjacente.
MAPI_E_USER_ABORT	O usuário cancelou a caixa de diálogo de logon ou a caixa de diálogo de detalhes.
SUCCESS_SUCCESS	A chamada foi bem-sucedida e a caixa de diálogo de detalhes foi exibida.

Comentários

A função MAPIDetails apresenta uma caixa de diálogo que mostra os detalhes de uma entrada de lista de endereços específica. O nome de exibição e o endereço são os atributos mínimos exibidos na caixa de diálogo; mais informações podem ser mostradas, dependendo do provedor do catálogo de endereços. A caixa de diálogo de detalhes não pode ser suprimida, mas o chamador pode solicitar que ele seja somente leitura ou modificável.

Os detalhes só podem ser mostrados para entradas de lista de endereços resolvidas. Uma entrada será resolvida se o valor do membro ulEIDSize da estrutura MapiRecipDesc não for zero. As entradas são resolvidas quando são retornadas pelas funções MAPIAddress ou MAPIResolveName e, como resultado, destinatários de emails de leitura.