WCM_LockApList

C Specification


#include <nitroWiFi/wcm.h>

s32   WCM_LockApList( s32 lock );
				

Description

A synchronous function that enables or disables writing to the internal list buffer that saves information about devices found during wireless access point auto-search.
Because device discovery notifications from the WM library occur in an interrupt handler, the WCM internal list buffer may be updated at unexpected times. Considering this phenomenon, when reading information from the internal list buffer, the interrupts need to be disabled, or the list will not be updated even when an interrupt occurs. This function disables the updating of the list, even when an interrupt occurs. It also enables normal updating.
Note that calling WCM_Init function will initialize the internal list buffer's update enable/disable setting to WCM_APLIST_UNLOCK.

Arguments

lock Specifies the value that controls the enabling and disabling update of the internal list buffer.
If WCM_APLIST_LOCK is specified, the update feature of the internal list buffer will be disabled and information about found devices will be discarded. If WCM_APLIST_UNLOCK is specified, the update feature of the internal list buffer will be enabled and the list may be updated as needed with information about found devices. If any other value is specified, updating will be disabled as if WCM_APLIST_LOCK had been specified.
< The default is WCM_APLIST_UNLOCK.>

Return Values

Returns the update enable/disable setting prior to the calling of this function as WCM_APLIST_LOCK or WCM_APLIST_UNLOCK. If called before the WCM library is initialized, it returns WCM_APLIST_UNLOCK.

See Also

WCM_Init, WCMConfig, WCM_ClearApList, WCM_CountApList, WCM_PointApList, WCM_PointApListLinkLevel

Revision History

07/22/2005 Initial version.