WCM_TerminateAsync

C Specification


#include <nitroWiFi/wcm.h>

s32   WCM_TerminateAsync( void );
				

Description

An asynchronous function that starts the WCM library's forced-stop sequence from an internal state in which there is no asynchronous processing. If the asynchronous process starts without problems, the internal state changes to WCM_PHASE_TERMINATING, and if the asynchronous process completes without problems, it becomes WCM_PHASE_WAIT. The state does not return to its pre-initialization state. This function can be executed when the internal state is WCM_PHASE_WAIT, WCM_PHASE_IDLE, WCM_PHASE_SEARCH, WCM_PHASE_DCF, or WCM_PHASE_IRREGULAR. But it cannot be executed when an asynchronous process is executing or when the state is WCM_PHASE_FATAL_ERROR. When the return value is WCM_RESULT_ACCEPT, the corresponding asynchronous process notification will be generated once and the callback function is called.

Arguments

None.

Return Values

Returns one of the following process results.

WCM_RESULT_ACCEPT Indicates that the request to start the asynchronous sequence was accepted and that the asynchronous process started normally. When the asynchronous process ends, the callback function is called once.
WCM_RESULT_PROGRESS Indicates that the asynchronous sequence started by this function is already executing and this was a duplicate call. Even with duplicate calls, the asynchronous process completion notification is generated only once.
WCM_RESULT_SUCCESS Indicates that the forced stop sequence for the WCM library has already completed, and the internal state is WCM_PHASE_WAIT. Since the asynchronous process is not started, an asynchronous process completion notification is not generated.
WCM_RESULT_REJECT Indicates that the PXI process request to the ARM7 failed when the function attempted to initiate the WCM library's forced-stop sequence. Because the internal state is not changed since this function is called, retry is possible.
WCM_RESULT_FAILURE Indicates the process failed because the WCM library was not initialized or the internal state was not suitable for execution.
WCM_RESULT_FATAL_ERROR Indicates that an unrecoverable error has occurred. Internal state becomes WCM_PHASE_FATAL_ERROR and does not change thereafter.

Asynchronous Process Results

One of the following asynchronous process results is passed to the callback function specified by WCM_StartupAsync function. The notification type is always WCM_NOTIFY_TERMINATE.

WCM_RESULT_SUCCESS Indicates the asynchronous process has succeeded and the WCM library was forcibly stopped without problems. The internal state becomes WCM_PHASE_WAIT.
WCM_RESULT_FAILURE Indicates that an error notification was received from the WM library during the asynchronous process. The internal state becomes WCM_PHASE_IRREGULAR.
WCM_RESULT_FATAL_ERROR Indicates that an unrecoverable error occurred during the asynchronous process. Internal state becomes WCM_PHASE_FATAL_ERROR and does not change thereafter.

See Also

WCM_Finish, WCM_StartupAsync, WCM_CleanupAsync

Revision History

07/22/2005 Initial version.