IDot11ExtUI::GetDot11ExtUIBalloonText method
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 IDot11ExtUI::GetDot11ExtUIBalloonText method allows the Native 802.11 IHV UI Extensions DLL to prepare the text for a balloon notification. The notification is requested by the IHV Extensions DLL through a call to Dot11ExtSendUIRequest.
Syntax
HRESULT GetDot11ExtUIBalloonText(
[in] BSTR pIHVUIRequest,
[out] BSTR *pwszBalloonText
);
Parameters
pIHVUIRequest [in]
The address of the structure created by the IHV Extensions DLL when making the UI request. The IHV Extensions DLL passes the address of this structure to the pIhvUIRequest parameter of the Dot11ExtSendUIRequest function.pwszBalloonText [out]
A pointer to a string buffer allocated by the Native 802.11 IHV UI Extensions DLL. This string buffer contains the localized text to be displayed within the balloon notification.
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 Native 802.11 IHV Extensions DLL can request the display of a balloon notification by calling Dot11ExtSendUIRequest. The DLL specifies the UI page to be displayed through a DOT11EXT_IHV_UI_REQUEST structure, which is passed to the pIhvUIRequest parameter of the Dot11ExtSendUIRequest function.
If no other UI component has registered with the operating system to suppress the display of balloon notifications, the operating system will follow these steps after the Native 802.11 IHV Extensions DLL calls the Dot11ExtSendUIRequest function:
Query the status of the UI request by calling the IHV Extension DLL's Dot11ExtIhvIsUIRequestPending IHV Handler function.
If the Native 802.11 IHV Extensions DLL passes a value of TRUE for the pbIsRequestPending parameter of the Dot11ExtIhvIsUIRequestPending function, call into the Native 802.11 IHV UI Extensions DLL through the IDot11ExtUI::GetDot11ExtUIBalloonText method. The Native 802.11 IHV UI Extensions DLL determines the UI page for the notification through the ihvUIRequest parameter. The DLL allocates a string buffer for the balloon text and passes the address of the string buffer to the bstrBalloonText parameter.
Display the balloon notification to the end user. If the end user clicks the balloon, the operating system can display a series of associated wizard pages by calling into the Native 802.11 IHV UI Extensions DLL's IWizardExtension::AddPages method.
For more information about the IWizardExtension COM Interface and its methods, see IWizardExtensionCOM Interface.
After the end user navigates through the series of pages associated with the UI request, call the Native 802.11 IHV Extensions DLL's Dot11ExtIhvProcessUIResponse function to complete the UI request.
For more information about the Native 802.11 IHV Extensions DLL, see Native 802.11 IHV Extensions.
Requirements
Target platform |
Desktop |
Minimum support |
Available in Windows Vista and later versions of the Windows operating systems. |
IDL |
Wlanihvui.idl |
See also