DOT11_BSS_ENTRY structure

Important  The Native 802.11 Wireless LAN interface is deprecated in Windows 10 and later. Please use the WLAN Device Driver Interface (WDI) instead. For more information about WDI, see WLAN Universal Windows driver model.
 

The DOT11_BSS_ENTRY structure defines an IEEE 802.11 Beacon or Response Frame that the 802.11 station received during its last scan operation.

Syntax


typedef struct DOT11_BSS_ENTRY {
  ULONG                             uPhyId;
  DOT11_BSS_ENTRY_PHY_SPECIFIC_INFO PhySpecificInfo;
  DOT11_MAC_ADDRESS                 dot11BSSID;
  DOT11_BSS_TYPE                    dot11BSSType;
  LONG                              lRSSI;
  ULONG                             uLinkQuality;
  BOOLEAN                           bInRegDomain;
  USHORT                            usBeaconPeriod;
  ULONGLONG                         ullTimestamp;
  ULONGLONG                         ullHostTimestamp;
  USHORT                            usCapabilityInformation;
  ULONG                             uBufferLength;
  UCHAR                             ucBuffer[1];
} DOT11_BSS_ENTRY, *PDOT11_BSS_ENTRY;

Members

uPhyId

The identifier (ID) of the PHY that the 802.11 station used to detect the BSS network. The PHY ID is the index within the list of supported PHYs returned by the driver through a query of OID_DOT11_SUPPORTED_PHY_TYPES.

This ID must not be DOT11_PHY_ID_ANY.

PhySpecificInfo

The attributes of the PHY referenced by the uPhyId member. PhySpecificInfo is formatted as a DOT11_BSS_ENTRY_PHY_SPECIFIC_INFO union.

dot11BSSID

The media access control (MAC) address of the access point (AP) (for infrastructure BSS networks) or peer station (for independent BSS networks) that sent the 802.11 Beacon or Probe Response frame received by the 802.11 station while scanning. The data type for this member is the DOT11_MAC_ADDRESS structure.

dot11BSSType

The BSS network type.

The data type for this member is the DOT11_BSS_TYPE enumeration. The miniport driver must not set this member to the dot11_BSS_type_any value.

lRSSI

The received signal strength indicator (RSSI) value, in units of decibels referenced to 1.0 milliwatts (dBm), as detected by the 802.11 station for the AP or peer station.

uLinkQuality

The link quality value ranging from 0 through 100. A value of 100 specifies the highest link quality. For more information about determining the link quality, see Link Quality Operations.

bInRegDomain

This member specifies whether the AP or peer station is operating within the regulatory domain as identified by the input country string. To set this member, the miniport driver must use the following guidelines:

  • If the 802.11 station does not support multiple regulatory domains, set the member to TRUE. For more information about multiple regulatory domains, see OID_DOT11_MULTI_DOMAIN_CAPABILITY_IMPLEMENTED.

  • If the input country string is all zeros, set the member to TRUE.

  • If the AP or peer station is not operating on a channel that is valid for the regulatory domain specified by the input country string, set the member to FALSE.

  • If the 802.11 Beacon or Probe Response frame, which was received from the AP or peer station, doesn't include a Country information element (IE), set the member to TRUE.

    For more information about the Country IE, refer to Clause 7.3.2.12 of the IEEE 802.11d-2001 standard.

  • If the 802.11 Beacon or Probe Response frame, which was received from the AP or peer station, does include a Country IE, set the member to FALSE if the value of the Country String subfield does not equal the input country string.

  • Set the member to TRUE in all other cases.

usBeaconPeriod

The value of the Beacon Interval field from the 802.11 Beacon or Probe Response frame.

ullTimestamp

The value of the Timestamp field from the 802.11 Beacon or Probe Response frame.

ullHostTimestamp

The timestamp, resolved through a call to NdisGetCurrentSystemTime, which records when the 802.11 station received the 802.11 Beacon or Probe Response frame.

usCapabilityInformation

The value of the Capability Information field from the 802.11 Beacon or Probe Response frame.

uBufferLength

The length, in bytes, of the ucBuffer array in the DOT11_BSS_ENTRY structure. ulBufferLength must be the exact length of the data in the ucBuffer array and must not contain any padding for alignment.

ucBuffer

The variable-length information elements (IEs) from the 802.11 Beacon or Probe Response frames. For each BSS, the IEs must be from the last Beacon or Probe Response frame received from that BSS network. If an IE is available in only one frame, the miniport driver must merge the IE with the other IEs from the last received Beacon or Probe Response frame.

When the NIC is in the Extensible Access Point (ExtAP) OP mode, the BSS list should contain an entry for the BSS that the NIC created.

For more information about the fields within IEEE 802.11 Beacon or Probe Response frames, refer to Clause 8.4 of the IEEE 802.11-2012 standard.

Remarks

When the 802.11 station performs a scan operation, the Native 802.11 miniport driver caches the received 802.11 Beacon and Probe Response frames. For more information about the scan operation, see Native 802.11 Scan Operations.

After the 802.11 station completes the scan operation, the miniport driver returns the list of the cached Beacon and Probe Response frames when queried by OID_DOT11_ENUM_BSS_LIST. A separate DOT11_BSS_ENTRY structure is formatted for each Beacon and Probe Response frame.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Windot11.h (include Ndis.h)

See also

DOT11_BSS_LIST
DOT11_BSS_TYPE
DOT11_MAC_ADDRESS
DOT11_BSS_ENTRY_PHY_SPECIFIC_INFO
NdisGetCurrentSystemTime
OID_DOT11_ENUM_BSS_LIST
OID_DOT11_MULTI_DOMAIN_CAPABILITY_IMPLEMENTED
OID_DOT11_SUPPORTED_PHY_TYPES

 

 

Send comments about this topic to Microsoft

Show: