DWC_SVLProcess

Syntax

#include <dwc.h>
DWCSvlState DWC_SVLProcess(void);

Arguments

None.

Return Values

DWC_SVL_STATE_DIRTY Retrieval of service locator information has not started.
DWC_SVL_STATE_IDLE The status immediately after starting the process for getting service allocator information. Communication with the authentication server has not started.
DWC_SVL_STATE_HTTP Communication with the authentication server is being performed for the process for getting service locator information.
DWC_SVL_STATE_SUCCESS Retrieval of service locator information has completed, and the service locator information has been stored in the specified DWCSvlResult variable.
DWC_SVL_STATE_ERROR Retrieval of service locator information has failed. Call DWC_GetLastErrorEx to check the error contents, then handle it as appropriate.
DWC_SVL_STATE_CANCELED The process for getting service locator information has been canceled.

Description

Advances the service locator information retrieval process and gets its current status as a return value. Call this function periodically until the process completes.

If retrieval of service locator information completes or is aborted and DWC_SVL_STATE_SUCCESS, DWC_SVL_STATE_ERROR, or DWC_SVL_STATE_CANCELED is returned, execution returns from this function with the retrieval process in an unstarted state.
Note: For this reason, DWC_SVL_STATE_DIRTY will be returned hereafter unless the process is restarted by the DWC_SVLGetTokenAsync function.

Revision History

5.1 PR2
Corrected a mistake in the definition name of a return value.
Added a description of return values when the process completes or is aborted.

For the changelog prior to 5.1 PR2, click here.


CONFIDENTIAL