Skip to content

Latest commit

 

History

History
210 lines (142 loc) · 8.16 KB

nf-wlanapi-wlanhostednetworkrefreshsecuritysettings.md

File metadata and controls

210 lines (142 loc) · 8.16 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:wlanapi.WlanHostedNetworkRefreshSecuritySettings
WlanHostedNetworkRefreshSecuritySettings function (wlanapi.h)
Refreshes the configurable and auto-generated parts of the wireless Hosted Network security settings.
WlanHostedNetworkRefreshSecuritySettings
WlanHostedNetworkRefreshSecuritySettings function [NativeWIFI]
nwifi.wlanhostednetworkrefreshsecuritysettings
wlanapi/WlanHostedNetworkRefreshSecuritySettings
nwifi\wlanhostednetworkrefreshsecuritysettings.htm
nwifi
9589e3a6-6e7a-4186-bfd0-a942a39ecafb
12/05/2018
WlanHostedNetworkRefreshSecuritySettings, WlanHostedNetworkRefreshSecuritySettings function [NativeWIFI], nwifi.wlanhostednetworkrefreshsecuritysettings, wlanapi/WlanHostedNetworkRefreshSecuritySettings
wlanapi.h
Wlanapi.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Wlanapi.lib
Wlanapi.dll
Windows
19H1
WlanHostedNetworkRefreshSecuritySettings
wlanapi/WlanHostedNetworkRefreshSecuritySettings
c++
APIRef
kbSyntax
DllExport
Wlanapi.dll
WlanHostedNetworkRefreshSecuritySettings

WlanHostedNetworkRefreshSecuritySettings function

-description

The WlanHostedNetworkRefreshSecuritySettings function refreshes the configurable and auto-generated parts of the wireless Hosted Network security settings.

-parameters

-param hClientHandle [in]

The client's session handle, returned by a previous call to the WlanOpenHandle function.

-param pFailReason [out, optional]

An optional pointer to a value that receives the failure reason, if the call to the WlanHostedNetworkRefreshSecuritySettings function fails. Possible values for the failure reason are from the WLAN_HOSTED_NETWORK_REASON enumeration type defined in the Wlanapi.h header file.

-param pvReserved

Reserved for future use. This parameter must be NULL.

-returns

If the function succeeds, the return value is ERROR_SUCCESS.

If the function fails, the return value may be one of the following return codes.

Return code Description
ERROR_INVALID_HANDLE
A handle is invalid. This error is returned if the handle specified in the hClientHandle parameter was not found in the handle table.
ERROR_INVALID_PARAMETER
A parameter is incorrect. This error is returned if any of the following conditions occur:
  • hClientHandle is NULL.
  • pvReserved is not NULL.
ERROR_INVALID_STATE
The resource is not in the correct state to perform the requested operation.
ERROR_SERVICE_NOT_ACTIVE
The service has not been started. This error is returned if the WLAN AutoConfig Service is not running.
Other
Various RPC and other error codes. Use FormatMessage to obtain the message string for the returned error.

-remarks

The WlanHostedNetworkRefreshSecuritySettings function is an extension to native wireless APIs added to support the wireless Hosted Network on Windows 7 and on Windows Server 2008 R2 with the Wireless LAN Service installed.

A client application calls the WlanHostedNetworkRefreshSecuritySettings function to force a refresh of the configurable and auto-generated parts of the security settings (the primary key) on the wireless Hosted Network.

An application might call the WlanHostedNetworkRefreshSecuritySettings function after ensuring that the user accepts the impact of updating the security settings. In order to succeed, this function must persist the new settings which would require that Hosted Network state be transitioned to wlan_hosted_network_idle if it was currently running (wlan_hosted_network_active).

Note  Any network clients (PCs or devices) on the wireless Hosted Network would have to be re-configured after calling the WlanHostedNetworkRefreshSecuritySettings function if their continued usage is a goal. An application would typically call this function in situations where the user feels that the security of the previous primary key used for security by the wireless Hosted Network has been violated. Note that the WlanHostedNetworkRefreshSecuritySettings function does not change or reset the secondary key.
 
Any Hosted Network state change caused by this function would not be automatically undone if the calling application closes its calling handle (by calling WlanCloseHandle with the hClientHandle parameter) or if the process ends.

Any user can call the WlanHostedNetworkRefreshSecuritySettings function to refresh the security settings on the Hosted Network. However, the ability to enable the wireless Hosted Network may be restricted by group policy in a domain.

On Windows 7 and later, the operating system installs a virtual device if a Hosted Network capable wireless adapter is present on the machine. This virtual device normally shows up in the “Network Connections Folder” as ‘Wireless Network Connection 2’ with a Device Name of ‘Microsoft Virtual WiFi Miniport adapter’ if the computer has a single wireless network adapter. This virtual device is used exclusively for performing software access point (SoftAP) connections and is not present in the list returned by the WlanEnumInterfaces function. The lifetime of this virtual device is tied to the physical wireless adapter. If the physical wireless adapter is disabled, this virtual device will be removed as well. This feature is also available on Windows Server 2008 R2 with the Wireless LAN Service installed.

-see-also

About the Wireless Hosted Network

Using Wireless Hosted Network and Internet Connection Sharing

WLAN_HOSTED_NETWORK_REASON

WLAN_SECURABLE_OBJECT

WlanCloseHandle

WlanEnumInterfaces

WlanHostedNetworkInitSettings

WlanHostedNetworkQueryProperty

WlanHostedNetworkQueryStatus

WlanHostedNetworkRefreshSecuritySettings

WlanHostedNetworkSetProperty

WlanHostedNetworkSetSecondaryKey

WlanOpenHandle