1.2.5.3 WDRV_WINC_BSSFindGetInfo Function

C

WDRV_WINC_STATUS WDRV_WINC_BSSFindGetInfo
(
DRV_HANDLE handle,
WDRV_WINC_BSS_INFO *const pBSSInfo
)

Summary

Requests the information structure of the current BSS scan result.

Description

After each call to either WDRV_WINC_BSSFindFirst or WDRV_WINC_BSSFindNext the driver receives a single BSS information structure which it stores. This function retrieves that structure.

Precondition

WDRV_WINC_Initialize must have been called. WDRV_WINC_Open must have been called to obtain a valid handle. WDRV_WINC_BSSFindFirst must have been called.

Parameters

ParamDescription
handleClient handle obtained by a call to WDRV_WINC_Open.
pBSSInfoPointer to structure to populate with the current BSS information.

Returns

WDRV_WINC_STATUS_OK - The request was accepted.

WDRV_WINC_STATUS_NOT_OPEN - The driver instance is not open.

WDRV_WINC_STATUS_INVALID_ARG - The parameters were incorrect.

WDRV_WINC_STATUS_NO_BSS_INFO - There is no current BBS information available.

Remarks

This function may be polled after calling WDRV_WINC_BSSFindFirst or WDRV_WINC_BSSFindNext until it returns WDRV_WINC_STATUS_OK.