WCM_EndSearchAsync

C Specification


#include <nitroWiFi/wcm.h>

s32   WCM_EndSearchAsync( void );
				

Description

An asynchronous function that initiates the stop sequence for wireless access point auto-search.
If the asynchronous process starts normally, the internal state changes from WCM_PHASE_SEARCH to WCM_PHASE_SEARCH_TO_IDLE; when the asynchronous process completes normally, it becomes WCM_PHASE_IDLE. This function can only be executed in these internal states.
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 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 access point auto-search has already completed, and the internal state was WCM_PHASE_IDLE. Since the asynchronous process is not started, an asynchronous process completion notification is not generated.
WCM_RESULT_FAILURE Indicates the process failed because the WCM library was not initialized or the internal state was not WCM_PHASE_SEARCH, WCM_PHASE_SEARCH_TO_IDLE, or WCM_PHASE_IDLE, etc.

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_END_SEARCH.

WCM_RESULT_SUCCESS Indicates that the asynchronous process succeeded and wireless access point auto-search stopped normally. The internal state becomes WCM_PHASE_IDLE.
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 or returns to WCM_PHASE_IDLE.
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_BeginSearchAsync, WCM_SearchAsync, WCM_TerminateAsync

Revision History

07/22/2005 Initial version.