nn::friends::CTR::Logout Function

Result Logout(
     os::Event * pEvent
);

	Name	Description
out	pEvent	Specifies a pointer to nn::os::Event, which signals that asynchronous processing is complete. Initialize this ahead of time using the nn::os::Event::Initialize function.

Returns the result of the operation.

Retracts a login request to a server.

If this function returns successfully asynchronous processing begins. The event nn::os::Event specified in the argument is signaled when asynchronous processing completes. Call the nn::friends::CTR::GetLastResponseResult function to get the result of the asynchronous operation. If this function fails, no asynchronous processing occurs.

When the local host is connecting to a server in the background, this function temporarily returns nn::friends::CTR::ResultTemporarilyBusy. In such cases, this function may succeed if you call it again after waiting a relatively short period of time.

This function will also succeed if called when the local host is already logged out. In such cases, the asynchronous processing instantly completes successfully.

Successful asynchronous processing does not guarantee that the local host is 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.

2010/08/16

Initial version.