IMAPISession::Logoff
Aplica-se a: Outlook 2013 | Outlook 2016
Encerra uma sessão MAPI.
HRESULT Logoff(
ULONG_PTR ulUIParam,
ULONG ulFlags,
ULONG ulReserved
);
Parâmetros
ulUIParam
[in] Um identificador para a janela pai de todas as caixas de diálogo ou janelas a serem exibidas. Esse parâmetro será ignorado se o sinalizador MAPI_LOGOFF_UI não estiver definido.
ulFlags
[in] Um bitmask de sinalizadores que controlam a operação de logoff. Os seguintes sinalizadores podem ser definidos:
MAPI_LOGOFF_SHARED
Se essa sessão for compartilhada, todos os clientes conectados usando a sessão compartilhada deverão ser notificados do logoff em andamento. Os clientes devem fazer logon. Qualquer cliente que esteja usando a sessão compartilhada pode definir esse sinalizador. MAPI_LOGOFF_SHARED será ignorado se a sessão atual não for compartilhada.
MAPI_LOGOFF_UI
O logoff pode exibir uma caixa de diálogo durante a operação, possivelmente solicitando a confirmação do usuário.
ulReserved
[in] Reservados; deve ser zero.
Valor de retorno
S_OK
A operação de logoff foi bem-sucedida.
Comentários
O método IMAPISession::Logoff encerra uma sessão MAPI. Quando Logoff retorna, nenhum dos métodos, exceto IUnknown::Release , pode ser chamado.
Notas para chamadores
Quando Logoff retornar, libere o objeto de sessão chamando seu método IUnknown::Release .
Para obter mais informações sobre como encerrar uma sessão, consulte Terminando uma sessão MAPI.
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MAPIObjects.cpp |
CMapiObjects::Logoff |
O MFCMAPI usa o método IMAPISession::Logoff para fazer logon da sessão antes de liberá-lo. |
Observação
Devido ao comportamento de desligamento rápido introduzido no Microsoft Office Outlook 2007 Service Pack 2, Microsoft Outlook 2010 e Microsoft Outlook 2013, os clientes nunca devem passar o parâmetro MAPI_LOGOFF_SHARED para IMAPISession::Logoff. Passar MAPI_LOGOFF_SHARED fará com que todos os clientes MAPI iniciem o desligamento e ocorrerão comportamentos inesperados.