IDot11ExtUIProperty::Dot11ExtUIPropertySetDisplayInfo method

Article
12/01/2017

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 operating system calls the IDot11ExtUIProperty::Dot11ExtUIPropertySetDisplayInfo method when the end user has selected a display element that the Native 802.11 IHV UI Extensions DLL added to the Security tab of the Network Configuration UI.

Syntax

HRESULT Dot11ExtUIPropertySetDisplayInfo(
  [in]  DOT11_EXT_UI_DISPLAY_INFO_TYPE     dot11ExtUIDisplayInfoType,
  [in]  BSTR                               bstrIHVProfile,
  [in]  PDOT11EXT_IHV_PARAMS               pIHVProfileParams,
  [in]  DOT11_EXT_UI_PROPERTY_DISPLAY_INFO *pDot11ExtUIProperty,
  [out] BSTR                               *bstrModifiedIHVProfile,
  [out] BOOL                               *pbIsModified
);

Parameters

dot11ExtUIDisplayInfoType [in]
The type of display element to be returned, as specified by a DOT11_EXT_UI_DISPLAY_INFO_TYPE value.
bstrIHVProfile [in]
The XML fragment that contains the IHV-defined data from the current security profile data. This fragment is bounded by the <IHV> and </IHV> XML tags. For more information about the format of the Native 802.11 profile data, refer to the documentation within the Microsoft Windows SDK.
pIHVProfileParams [in]
A pointer to a DOT11EXT_IHV_PROFILE_PARAMS structure that specifies the parameters of the current security profile.
pDot11ExtUIProperty [in]
A pointer to a DOT11_EXT_UI_PROPERTY_DISPLAY_INFO structure that specifies the display element selected by the end user.
bstrModifiedIHVProfile [out]
A pointer to a string buffer allocated by the Native 802.11 IHV UI Extensions DLL. This string buffer contains the modified profile data for the property extension.
pbIsModified [out]
A pointer to a Boolean variable. The IDot11ExtUIProperty::Dot11ExtUIPropertySetDisplayInfo method must set * pbIsModified to TRUE if it is returning modified profile data through the bstrModifiedIHVProfile parameter.

Return value

If the call succeeds, the method returns S_OK.

If the call fails, the method returns the appropriate error code defined in Winerror.h.

Remarks

If the Native 802.11 IHV UI Extensions DLL supports an IDot11ExtUIProperty COM Interface for a property type of DOT11_EXT_UI_KEYEXTENSION, the operating system calls the interface's IDot11ExtUIProperty::Dot11ExtUIPropertyGetDisplayInfo method before displaying the Security tab in the Network Configuration UI. The operating system queries the property extensions supported by the Native 802.11 IHV UI Extensions DLL by calling the IDot11ExtUI::GetDot11ExtUIProperties method.

The operating system calls this method to populate the Encryption list with IHV-supported extensions. By using this method, the Native 802.11 IHV UI Extensions DLL can return one or more entries to add to the Encryption list.

When the end user makes a selection in the Encryption list, the operating system calls the IDot11ExtUIProperty::Dot11ExtUIPropertySetDisplayInfo method to pass the relevant IHV-defined profile data to the IHV UI Extensions DLL for processing.

The following points apply to the modified profile data that is passed through the bstrIHVProfile parameter of the IDot11ExtUIProperty::Dot11ExtUIPropertySetDisplayInfo method:

If the Native 802.11 IHV UI Extensions DLL makes changes to the profile data for the property extension, it must allocate a string buffer that contains the modified profile data. In this situation, the DLL returns the address of the string buffer through the bstrModifiedIHVProfile parameter and sets * pbIsModified to TRUE.

The operating system passes a pointer to the modified profile data to the bstrIHVProfile parameter in subsequent calls to the IDot11ExtUIProperty::DisplayDot11ExtUIProperty method for the property extension.
If the Native 802.11 IHV UI Extensions DLL does not need to make changes to the profile data, it must set bstrModifiedIHVProfile to NULL and * pbIsModified to FALSE.

For more information about extending the properties of the Network Configuration UI, see Extending the Properties for Wireless Network Profiles.

For more information about the Network Configuration UI and other Native 802.11 components, see Native 802.11 Software Architecture.

Requirements

Target platform	Desktop
Minimum support	Available in Windows Vista and later versions of the Windows operating systems.
IDL	Wlanihvui.idl