WCM_PointApListLinkLevel

C Specification


#include <nitroWiFi/wcm.h>

WMLinkLevel  WCM_PointApListLinkLevel( s32 index );
				

Description

This is a synchronous function that obtains the signal strength at the time of discovery of the devices found during wireless access point auto-search. This function obtains only the signal strength at the time of discovery; this information is not included in the data obtained with the WCM_PointApList function. Accordingly, use it in tandem with WCM_PointApList function.

Information for multiple wireless access points may be listed in the internal buffer. Accordingly, index that specifies the information must be passed as an argument.
During wireless access point auto-search, the internal list buffer's state is updated at irregular intervals. 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 connection signal strength of the wireless access point at the time of discovery as a WMLinkLevel enumerated type. Returns WM_LINK_LEVEL_0 if the acquisition fails because the WCM library has not been initialized or if there is no information that has index specified for an argument.

See Also

WCM_StartupAsync, WCMConfig, WCM_LockApList, WCM_ClearApList, WCM_CountApList, WCM_PointApList, WCM_GetLinkLevel

Revision History

07/22/2005 Initial version.