OID_DOT11_SUPPORTED_COUNTRY_OR_REGION_STRING

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.

 

When queried, the OID_DOT11_SUPPORTED_COUNTRY_OR_REGION_STRING object identifier (OID) requests that the miniport driver return a list of the country strings identifying the regulatory domains supported by the 802.11 station. For more information about country strings, refer to the IEEE 802.11d-2001 standard.

The data type for this OID is the DOT11_COUNTRY_OR_REGION_STRING_LIST structure.

    typedef struct DOT11_COUNTRY_OR_REGION_STRING_LIST {
         NDIS_OBJECT_HEADER Header;
         ULONG uNumOfEntries;
         ULONG uTotalNumOfEntries;
         DOT11_COUNTRY_OR_REGION_STRING CountryOrRegionStrings[1];
    } DOT11_COUNTRY_OR_REGION_STRING_LIST, *PDOT11_COUNTRY_OR_REGION_STRING_LIST;
  

This structure includes the following members:

Header
The type, revision, and size of the DOT11_COUNTRY_OR_REGION_STRING_LIST structure. This member is formatted as an NDIS_OBJECT_HEADER structure.

The miniport driver must set the members of Header to the following values:

Type
This member must be set to NDIS_OBJECT_TYPE_DEFAULT.

Revision
This member must be set to DOT11_COUNTRY_OR_REGION_STRING_LIST_REVISION_1.

Size
This member must be set to sizeof(DOT11_COUNTRY_OR_REGION_STRING_LIST).

For more information about these members, see NDIS_OBJECT_HEADER.

uNumOfEntries
Number of entries in the CountryOrRegionStrings array. A zero value for this member indicates an empty country string list.

uTotalNumOfEntries
Maximum number of entries that the CountryOrRegionStrings array can contain.

CountryOrRegionStrings
The list of supported 802.11d country strings. For more information about the data type of this member, see DOT11_COUNTRY_OR_REGION_STRING.

When OID_DOT11_SUPPORTED_COUNTRY_OR_REGION_STRING is queried, the miniport driver must verify that the InformationBuffer member of the MiniportOidRequest function's OidRequest parameter is large enough to return the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure, including all entries in the CountryOrRegionStrings array. The value of the InformationBufferLength member of the OidRequest parameter determines what the miniport driver must do, as the following list shows:

  • If the value of the InformationBufferLength member is less than the length, in bytes, of the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure, the miniport driver must do the following:

    • Set the uNumOfEntries member to zero.

    • Set the uTotalNumOfEntries member to the number of entries in the CountryOrRegionStrings array.

    • For the OidRequest parameter, set the BytesWritten member to zero and the BytesNeeded member to the length, in bytes, of the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure.

    • Fail the query request by returning NDIS_STATUS_BUFFER_OVERFLOW from its MiniportOidRequest function.

  • If the value of the InformationBufferLength member is greater than or equal to the length, in bytes, of the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure, the miniport driver must do the following to complete a successful query request:

    • For the DOT11_COUNTRY_OR_REGION_STRING_LIST structure, set the uNumOfEntries and uTotalNumOfEntries members to the total number of entries in the CountryOrRegionStrings array.

    • For the OidRequest parameter, set the BytesNeeded member to zero and the BytesWritten member to the length, in bytes, of the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure. The miniport driver must also copy the entire DOT11_COUNTRY_OR_REGION_STRING_LIST structure to the InformationBuffer member.

    • Return NDIS_STATUS_SUCCESS from its MiniportOidRequest function.

Requirements

Version

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

Header

Windot11.h (include Ndis.h)

See also

Native 802.11 Wireless LAN OIDs