IMessenger::Signout method

[Signout is no longer available for use as of Windows Vista. See Windows Messenger for more information.]

Signs the current client user out of all Mesenger services.

Syntax

HRESULT Signout();

Parameters

This method has no parameters.

Return value

Type: HRESULT

Returns one of the following values.

Return code Description
S_OK
Success.
E_FAIL
Could not find the Messenger object or could not send the outgoing protocol message.
MSGR_E_NOT_LOGGED_ON
Not signed in to the primary service when the sign-out was attempted.

Remarks

If the client supports sign-in to multiple services, this method will disconnect the client from all services.

If successful, invoking this method will result in a OnSignout event. Signing out also results in a OnMyStatusChange event with mMYStatusOE=MISTATUS_LOCAL_DISCONNECTING_FROM_SERVER. This state persists until the server of the service receives and responds to the protocol-level logoff command.

Note

This method is not available for scripting languages.

Requirements

End of client support
Windows XP
End of server support
Windows Server 2003
Header
Msgrua.h
IDL
Msgrua.idl
DLL
Msgsc.dll

See also

IMessenger

OnAppShutdown