IMessage::GetRecipientTable
Aplica-se a: Outlook 2013 | Outlook 2016
Retorna a tabela de destinatário da mensagem.
HRESULT GetRecipientTable(
ULONG ulFlags,
LPMAPITABLE FAR * lppTable
);
Parâmetros
ulFlags
[in] Máscara de bits de sinalizadores que controla o retorno da tabela. Os seguintes sinalizadores podem ser definidos:
MAPI_DEFERRED_ERRORS
Permite que GetRecipientTable retorne com êxito, possivelmente antes que a tabela esteja totalmente disponível para o cliente de chamada. Se a tabela não estiver disponível, fazer uma chamada subsequente a ela poderá causar um erro.
MAPI_UNICODE
As colunas de cadeia de caracteres devem estar no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, as colunas de cadeia de caracteres deverão estar no formato ANSI.
lppTable
[out] Ponteiro para um ponteiro para a tabela do destinatário.
Valor de retorno
S_OK
A tabela do destinatário foi retornada com êxito.
Comentários
O método IMessage::GetRecipientTable retorna um ponteiro para a tabela de destinatário da mensagem, que inclui informações sobre todos os destinatários da mensagem. Há uma linha para cada destinatário.
As tabelas do destinatário têm um conjunto de colunas diferente, dependendo se a mensagem foi enviada. Para obter uma lista completa das colunas em uma tabela de destinatário, consulte Tabelas de Destinatário.
Algumas tabelas de destinatário dão suporte a uma ampla variedade de restrições; outros não. O suporte para restrições depende da implementação do provedor do repositório de mensagens.
Definir o sinalizador de MAPI_UNICODE no parâmetro ulFlags afeta as seguintes chamadas para a tabela de destinatário:
IMAPITable::QueryColumns para recuperar o conjunto de colunas.
IMAPITable::QueryRows para recuperar linhas.
IMAPITable::QuerySortOrder para recuperar a ordem de classificação.
Definir o sinalizador Unicode solicita que as informações de todas as colunas de cadeia de caracteres retornadas dessas chamadas estejam no formato Unicode. No entanto, como nem todos os provedores do repositório de mensagens dão suporte ao Unicode, definir esse sinalizador é apenas uma solicitação.
Notas para chamadores
Você pode alterar uma tabela de destinatário enquanto ela está aberta chamando o método IMessage::ModifiRecipients . ModifiRecipients adiciona destinatários, exclui destinatários ou modifica propriedades do destinatário.