WCM_PointApList

C Specification


#include <nitroWiFi/wcm.h>

WMBssDesc*  WCM_PointApList( s32 index );
				

Description

A synchronous function that obtains information about devices found during wireless access point auto-search.
Data for mutliple wireless access points may be listed in the internal buffer. Accordingly, index , which specifies the information, must be passed to the argument. The wireless access point information obtained by this function is a pointer to a WMBssDesc structure. The buffer is the internal list buffer that is passed when WCM_StartupAsync is called. During wireless access point auto-search, the internal list buffer's state is updated at random times. Therefore, we recommend using this function after disabling updates of the internal list by calling the WCM_LockApList function.

Arguments

index Specifies the index that identifies the information that may be listed multiple times.
Valid index values are from 0 to [the number of device information obtained using WCM_CountApList function -1].

Return Values

Returns the wireless access point information as a pointer to a WMBssDesc structure. Returns NULL if the acquisition fails because the WCM library has not been initialized or if there is no information that has index specified as an argument.

See Also

WCM_StartupAsync, WCMConfig, WCM_LockApList, WCM_ClearApList, WCM_CountApList, WCM_PointApListLinkLevel

Revision History

07/22/2005 Initial version.