1.2.3.9 WDRV_PIC32MZW_BSSFindGetInfo Function
WDRV_PIC32MZW_STATUS WDRV_PIC32MZW_BSSFindGetInfo (
DRV_HANDLE handle, WDRV_PIC32MZW_BSS_INFO *const pBSSInfo
)
C
Summary
Requests the information structure of the current BSS scan result.
Description
After each call to either WDRV_PIC32MZW_BSSFindFirst or WDRV_PIC32MZW_BSSFindNext the driver receives a single BSS information structure which it stores. This function retrieves that structure.
Precondition
WDRV_PIC32MZW_Initialize must have been called. WDRV_PIC32MZW_Open must have been called to obtain a valid handle. WDRV_PIC32MZW_BSSFindFirst must have been called.
Parameters
Param | Description |
handle | Client handle obtained by a call to WDRV_PIC32MZW_Open. |
pBSSInfo | Pointer to structure to populate with the current BSS information. |
Returns
WDRV_PIC32MZW_STATUS_OK - The request was accepted. WDRV_PIC32MZW_STATUS_NOT_OPEN - The driver instance is not open. WDRV_PIC32MZW_STATUS_INVALID_ARG - The parameters were incorrect. WDRV_PIC32MZW_STATUS_NO_BSS_INFO - There is no current BBS information available.
Remarks
This function may be polled after calling WDRV_PIC32MZW_BSSFindFirst or WDRV_PIC32MZW_BSSFindNext until it returns WDRV_PIC32MZW_STATUS_OK.