WCM_CleanupAsync

C Specification


#include <nitroWiFi/wcm.h>

s32   WCM_CleanupAsync( void );
				

Description

An asynchronous function that initiates the sequence to stop the wireless communication functionality. If the asynchronous process starts normally, the internal state changes from WCM_PHASE_IDLE to WCM_PHASE_IDLE_TO_WAIT; when the asynchronous process completes normally, it becomes WCM_PHASE_WAIT. This function can only be executed in these internal states. When the return value is WCM_RESULT_ACCEPT, the corresponding asynchronous process notification is 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 will be 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 stop sequence for the wireless communication functionality has already completed, and the internal state was WCM_PHASE_WAIT. Since the asynchronous process is not started, an asynchronous process completion notification is not generated.
WCM_RESULT_REJECT Indicates that when the function attempted to initiate the sequence to stop the wireless communication functionality, the issue of a PXI process request to the ARM7 failed. The internal state remains WCM_PHASE_IDLE and another attempt can be made.
WCM_RESULT_FAILURE Indicates the process failed because the WCM library was not initialized and the internal state was not WCM_PHASE_IDLE, WCM_PHASE_IDLE_TO_WAIT, or WCM_PHASE_WAIT, etc.
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_CLEANUP.

WCM_RESULT_SUCCESS Indicates the asynchronous process has succeeded and the wireless functionality was stopped normally. 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_TerminateAsync

Revision History

07/22/2005 Initial version.