IMAPIFolder::GetMessageStatus
Aplica-se a: Outlook 2013 | Outlook 2016
Obtém o status associado a uma mensagem em uma pasta específica (por exemplo, se essa mensagem está marcada para exclusão).
HRESULT GetMessageStatus(
ULONG cbEntryID,
LPENTRYID lpEntryID,
ULONG ulFlags,
ULONG FAR * lpulMessageStatus
);
Parâmetros
cbEntryID
[in] A contagem de bytes no identificador de entrada apontada pelo parâmetro lpEntryID .
Lpentryid
[in] Um ponteiro para o identificador de entrada da mensagem cujo status é obtido.
ulFlags
[in] Reservados; deve ser zero.
lpulMessageStatus
[out] Um ponteiro para um ponteiro para uma máscara de sinalizadores que indicam o status da mensagem. Os bits 0 a 15 são reservados e devem ser zero; bits 16 a 31 estão disponíveis para uso específico da implementação. Os seguintes sinalizadores podem ser definidos:
MSGSTATUS_DELMARKED
A mensagem foi marcada para exclusão.
MSGSTATUS_HIDDEN
A mensagem não deve ser exibida.
MSGSTATUS_HIGHLIGHTED
A mensagem deve ser exibida realçada.
MSGSTATUS_REMOTE_DELETE
A mensagem foi marcada para exclusão no repositório de mensagens remotas sem baixar para o cliente local.
MSGSTATUS_REMOTE_DOWNLOAD
A mensagem foi marcada para download do repositório de mensagens remoto para o cliente local.
MSGSTATUS_TAGGED
A mensagem foi marcada para uma finalidade definida pelo cliente.
Valor de retorno
S_OK
A mensagem status foi recuperada com êxito.
Comentários
O método IMAPIFolder::GetMessageStatus retorna o status de uma mensagem. O status de mensagem é armazenado na propriedade PR_MSG_STATUS da mensagem (PidTagMessageStatus).
Observações para implementadores
Como a mensagem status bits são definidas, desmarcadas e usadas depende completamente da implementação, exceto que os bits 0 a 15 são reservados e devem ser zero. Se você armazenar mensagens na sub-árvore do IPM, o MAPI reserva bits de 16 a 31 para uso por clientes IPM. Se você armazenar mensagens em outras sub-árvores, poderá usar bits de 16 a 31 para seus próprios propósitos.
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MyMAPIFormViewer.cpp |
CMyMAPIFormViewer::GetNextMessage |
O MFCMAPI usa o método IMAPIFolder::GetMessageStatus para obter o status da próxima mensagem a ser exibida. |
| MAPIFormFunctions.cpp |
OpenMessageNonModal e OpenMessageModal |
O MFCMAPI usa o método IMAPIFolder::GetMessageStatus para obter o status da mensagem a ser exibida para passar para o visualizador de formulário, que é CMyMAPIFormViewer ou IMAPISession::ShowForm. |