WCM_Finish

C Specification


#include <nitroWiFi/wcm.h>

s32   WCM_Finish( void );
				

Description

A synchronous function that terminates the WCM library and returns it to the pre-initialization state.
The function can only be executed after the library has been initialized with the WCM_Init function and the WCM library's internal state is WCM_PHASE_WAIT.

If termination was successful, then the APIs included in the WCM library cannot be used until the library is initialized again with WCM_Init. However, the work buffer passed with WCM_Init is released so it can be used for other purposes.

Arguments

None.

Return Values

Returns one of the following process results.

WCM_RESULT_SUCCESS Indicates that the termination process completed normally.
WCM_RESULT_FAILURE Indicates the termination process failed because the WCM library was not initialized, the internal state was not WCM_PHASE_WAIT, etc.

See Also

WCM_Init, WCM_CleapupAsync, WCM_TerminateAsync

Revision History

07/22/2005 Initial version.