DWC_NASLoginProcess

Syntax

#include <dwc.h>
DWCNasLoginState DWC_NASLoginProcess(void);

Arguments

None.

Return Values

DWC_NASLOGIN_STATE_DIRTY Authentication process has not started.
DWC_NASLOGIN_STATE_HTTP HTTP network communication for the authentication process is running.
DWC_NASLOGIN_STATE_SUCCESS Authentication process was successful.
DWC_NASLOGIN_STATE_ERROR Authentication process failed. Call DWC_GetLastErrorEx to check the error contents, then handle it as appropriate.
DWC_NASLOGIN_STATE_CANCELED Authentication process was cancelled.

Description

Advances an ongoing Nintendo authentication server authentication process and gets the state of the process. Call it approximately once per game frame until the authentication process is complete.

If authentication completes or is aborted and DWC_NASLOGIN_STATE_SUCCESS, DWC_NASLOGIN_STATE_ERROR, or DWC_NASLOGIN_STATE_CANCELED is returned, execution returns from this function with the authentication process in an unstarted state.
Note: For this reason, DWC_NASLOGIN_STATE_DIRTY will be returned hereafter unless the process is restarted by the DWC_NASLoginAsync function.

To process errors that occur inside this function, after calling it, get the error status using the DWC_GetLastErrorEx function. If necessary, display an error code in addition to an error message.

Revision History

5.1 PR2
Added a description of return values when the process completes or is aborted.

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL