IMAPIFolder::EmptyFolder
Aplica-se a: Outlook 2013 | Outlook 2016
Exclui todas as mensagens e subpastas de uma pasta sem excluir a pasta em si.
HRESULT EmptyFolder(
ULONG_PTR ulUIParam,
LPMAPIPROGRESS lpProgress,
ULONG ulFlags
);
Parâmetros
ulUIParam
[in] Um identificador para a janela pai do indicador de progresso. O parâmetro ulUIParam é ignorado, a menos que o sinalizador FOLDER_DIALOG seja definido no parâmetro ulFlags .
lpProgress
[in] Um ponteiro para um objeto de progresso que exibe um indicador de progresso. Se NULL for passado em lpProgress, o provedor do repositório de mensagens exibirá um indicador de progresso usando a implementação do objeto de progresso MAPI. O parâmetro lpProgress é ignorado, a menos que o sinalizador FOLDER_DIALOG seja definido no parâmetro ulFlags .
ulFlags
[in] Um bitmask de sinalizadores que controla como a pasta é esvaziada. Os seguintes sinalizadores podem ser definidos:
DEL_ASSOCIATED
Exclui todas as subpastas, incluindo subpastas que contêm mensagens com conteúdo associado. O sinalizador DEL_ASSOCIATED tem significado apenas para a pasta de nível superior em que a chamada atua.
DELETE_HARD_DELETE
Remove permanentemente todas as mensagens, incluindo as excluídas.
FOLDER_DIALOG
Exibe um indicador de progresso enquanto a operação prossegue.
Valor de retorno
S_OK
A pasta foi esvaziada com êxito.
MAPI_W_PARTIAL_COMPLETION
A chamada foi bem-sucedida, mas a pasta não foi completamente esvaziada. Quando esse aviso é retornado, a chamada deve ser tratada como bem-sucedida. Para testar esse aviso, use a macro HR_FAILED . Para obter mais informações, confira Usando macros para tratamento de erros.
Comentários
O método IMAPIFolder::EmptyFolder exclui todo o conteúdo de uma pasta sem excluir a pasta em si.
Durante uma chamada EmptyFolder , as mensagens enviadas não são excluídas.
O conteúdo associado de uma pasta inclui mensagens que são usadas para descrever exibições, regras, formulários personalizados e armazenamento de soluções personalizadas e também podem incluir definições de formulário.
Observações para implementadores
Não chame o método IMsgStore::AbortSubmit para mensagens na pasta que foram enviadas. As mensagens enviadas não são excluídas.
Notas para chamadores
Espere esses valores retornados nas seguintes condições.
| Condition | Valor de retorno |
|---|---|
| O EmptyFolder esvaziou com êxito a pasta. | S_OK |
| EmptyFolder não pôde esvaziar completamente a pasta. | MAPI_W_PARTIAL_COMPLETION |
| O EmptyFolder não pôde ser concluído. | Qualquer valor de erro |
Quando EmptyFolder não puder ser concluído, não suponha que nenhum trabalho tenha sido feito. O EmptyFolder pode ter sido capaz de excluir parte do conteúdo da pasta antes de encontrar o erro.
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MsgStoreDlg.cpp |
CMsgStoreDlg::OnEmptyFolder |
O MFCMAPI usa o método IMAPIFolder::EmptyFolder para excluir o conteúdo da pasta especificada. |