IDot11ExtUIProperty::DisplayDot11ExtUIProperty 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 IDot11ExtUIProperty::DisplayDot11ExtUIProperty method allows the Native 802.11 IHV UI Extensions DLL to configure the proprietary settings that are displayed within a connectivity or security property extension.

Syntax

HRESULT DisplayDot11ExtUIProperty(
  [in]  HWND                 hParent,
  [in]  BSTR                 bstrIHVProfile,
  [in]  PDOT11EXT_IHV_PARAMS pIHVProfileParams,
  [out] BSTR                 *bstrModifiedIHVProfile,
  [out] BOOL                 *pbIsModified
);

Parameters

hParent [in]
The handle of the parent window in the 802.11 network configuration UI. The IHV-supported UI will be displayed as a modal child of this window.
bstrIHVProfile [in]
The XML fragment that contains the IHV-defined data from the current 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.

This parameter will be NULL if no proprietary profile data has been previously defined for the property extension.
pIHVProfileParams [in]
The parameters of the current security profile, formatted as a DOT11EXT_IHV_PROFILE_PARAMS structure.
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 Native 802.11 IHV UI Extensions DLL 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

The operating system will call the IDot11ExtUIProperty::DisplayDot11ExtUIProperty method before it displays the property extension that is defined by the independent hardware vendor (IHV). When this method is called, the Native 802.11 IHV UI Extensions DLL must follow these guidelines:

If the Native 802.11 IHV UI Extensions DLL makes changes to the profile data for the property page 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.

If the Native 802.11 IHV UI Extensions DLL returns changes to the property extension, the operating system will pass 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.

Requirements

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