WlanSetAutoConfigParameter function (wlanapi.h)
The WlanSetAutoConfigParameter function sets parameters for the automatic configuration service.
DWORD WlanSetAutoConfigParameter(
[in] HANDLE hClientHandle,
[in] WLAN_AUTOCONF_OPCODE OpCode,
[in] DWORD dwDataSize,
[in] const PVOID pData,
PVOID pReserved
);
[in] hClientHandle
The client's session handle, obtained by a previous call to the WlanOpenHandle function.
[in] OpCode
A WLAN_AUTOCONF_OPCODE value that specifies the parameter to be set. Only some of the opcodes in the WLAN_AUTOCONF_OPCODE enumeration support set operations.
[in] dwDataSize
The size of the pData parameter, in bytes. This parameter must be set to sizeof(BOOL)
for a BOOL or sizeof(DWORD)
for a DWORD, depending on the value of the OpCode parameter.
[in] pData
The value to be set for the parameter specified in OpCode parameter. The pData parameter must point to a boolean or DWORD value, depending on the value of the OpCode parameter. The pData parameter must not be NULL.
pReserved
Reserved for future use. Must be set to NULL.
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 |
---|---|
|
Access is denied. This error is returned if the caller does not have sufficient permissions to set the configuration parameter when the OpCode parameter is wlan_autoconf_opcode_show_denied_networks or wlan_autoconf_opcode_allow_virtual_station_extensibility. When the OpCode parameter is set to one of these values, the WlanSetAutoConfigParameter function retrieves the discretionary access control list (DACL) stored for opcode object. If the DACL does not contain an access control entry (ACE) that grants WLAN_WRITE_ACCESS permission to the access token of the calling thread, then WlanSetAutoConfigParameter returns ERROR_ACCESS_DENIED.
This error is also returned if the configuration parameter is set by group policy on a domain. When group policy is set for an opcode, applications are prevented from making changes. For the following OpCode parameters may be set by group policy: wlan_autoconf_opcode_show_denied_networks, wlan_autoconf_opcode_allow_explicit_creds, and wlan_autoconf_opcode_block_period |
|
A parameter was bad. This error is returned if the hClientHandle parameter is NULL, the pData parameter is NULL, or the pReserved parameter is not NULL. This error is also returned if OpCode parameter specified is not one of the WLAN_AUTOCONF_OPCODE values for a configuration parameter that can be set. This error is also returned if the dwDataSize parameter is not set to sizeof(BOOL) , or the dwDataSize is not set to sizeof(BOOL) depending on the value of the OpCode parameter.
|
|
The handle hClientHandle was not found in the handle table. |
|
This function was called from an unsupported platform. This value will be returned if this function was called from a Windows XP with SP3 or Wireless LAN API for Windows XP with SP2 client. |
|
Various error codes. |
The WlanSetAutoConfigParameter function sets parameters used by Auto Configuration Module (ACM), the wireless configuration component supported on Windows Vista and later.
Depending on the value of the OpCode parameter, the data pointed to by pData will be converted to a boolean value before the automatic configuration parameter is set. If pData points to 0, then the parameter is set to FALSE; otherwise, the parameter is set to TRUE.
Requirement | Value |
---|---|
Minimum supported client | Windows Vista [desktop apps only] |
Minimum supported server | Windows Server 2008 [desktop apps only] |
Target Platform | Windows |
Header | wlanapi.h (include Wlanapi.h) |
Library | Wlanapi.lib |
DLL | Wlanapi.dll |