IMAPISession::GetMsgStoresTable
Aplica-se a: Outlook 2013 | Outlook 2016
Fornece acesso à tabela do repositório de mensagens que contém informações sobre todos os armazenamentos de mensagens no perfil da sessão.
HRESULT GetMsgStoresTable(
ULONG ulFlags,
LPMAPITABLE FAR * lppTable
);
Parâmetros
ulFlags
[in] Um bitmask de sinalizadores que determina o formato para colunas que são cadeias de caracteres. O seguinte sinalizador pode ser definido:
MAPI_UNICODE
As colunas de cadeia de caracteres estão no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, as colunas de cadeia de caracteres estarão no formato ANSI.
lppTable
[out] Um ponteiro para um ponteiro para a tabela do repositório de mensagens.
Valor de retorno
S_OK
A tabela foi retornada com êxito.
MAPI_E_BAD_CHARWIDTH
O sinalizador MAPI_UNICODE foi definido e a sessão não dá suporte ao Unicode.
Comentários
O método IMAPISession::GetMsgStoresTable recupera um ponteiro para a tabela do repositório de mensagens, uma tabela mantida pelo MAPI que contém informações sobre cada repositório de mensagens aberto no perfil.
Para obter uma lista completa de colunas necessárias e opcionais na tabela do repositório de mensagens, consulte Tabelas do Repositório de Mensagens.
Notas para chamadores
Como o MAPI atualiza a tabela do repositório de mensagens durante a sessão sempre que ocorrerem alterações, chame o método Aconselhar da tabela do repositório de mensagens para se registrar para ser notificado dessas alterações. As possíveis alterações incluem a adição de novos repositórios de mensagens, remoção de lojas existentes e alterações no repositório padrão.
Definir o sinalizador MAPI_UNICODE no parâmetro ulFlags afeta o formato das colunas retornadas dos métodos IMAPITable::QueryColumns e IMAPITable::QueryRows . Esse sinalizador também controla os tipos de propriedade na ordem de classificação retornada pelo método IMAPITable::QuerySortOrder .
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MainDlg.cpp |
CMainDlg::OnOpenMessageStoreTable |
O MFCMAPI usa o método IMAPISession::GetMsgStoresTable para obter a tabela do repositório de mensagens para que ela possa ser renderizada na caixa de diálogo main do MFCMAPI. |