nn::friends::CTR::Logout Function

Syntax

Result Logout();

Parameters

None.

Return Values

Returns the result of the operation.

Value Description
Result::IsSuccess Process succeeded.
ResultNotInitialized The friend presence library is not initialized.
Other Another result may be returned, depending on the internal state of the daemon and other factors.

Description

Retracts a login request to a server.

This function succeeds even if it is called when the local host has already logged out. Even if this function succeeds, the local host is not guaranteed to be offline.

In cases where the local host has become disconnected from the server, the system silently transitions to the same state as if this function has been called.

Revision History

2011/03/11
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL