Share via

WlanSetAutoConfigParameter (Compact 7)

  • Article

3/12/2014

This function sets parameters for the automatic configuration service.

Syntax

DWORD WINAPI WlanSetAutoConfigParameter(
  __in        HANDLE hClientHandle,
  __in        WLAN_AUTOCONF_OPCODE OpCode,
  __in        DWORD dwDataSize,
  __in        const PVOID pData,
  __reserved  PVOID pReserved
);

Parameters

  • hClientHandle
    Client session handle, obtained by a previous call to the WlanOpenHandle function.

  • OpCode
    A WLAN_AUTOCONF_OPCODE value that specifies the parameter to be set.

    Value Meaning

    wlan_autoconf_opcode_show_denied_networks

    When set, the pData parameter contains a BOOL value that indicates whether user-denied networks will be included in the available networks list.
  • dwDataSize
    Size of the pData parameter, in bytes. This parameter must be set to sizeof(BOOL).

  • pData
    Value to be set for the parameter specified in OpCode. pData should point to a Boolean value. This parameter must not be NULL.

    Note

    pData can point to an integer value. If pData points to 0, the value is converted to FALSE. If pData points to a nonzero integer, the value is converted to TRUE.

  • pReserved
    Reserved. Set to NULL.

Return Values

Value Description

ERROR_SUCCESS

The function succeeds.

ERROR_ACCESS_DENIED

The caller does not have sufficient permissions to set configuration parameters.

ERROR_INVALID_PARAMETER

hClientHandle is NULL or invalid, pReserved is not NULL, OpCode is not set to wlan_autoconf_opcode_show_denied_networks, dwDataSize is not set to sizeof(BOOL), or pData is NULL.

ERROR_INVALID_HANDLE

The handle hClientHandle was not found in the handle table.

ERROR_NOT_SUPPORTED

This function was called from an unsupported platform.

RPC_STATUS

Can be any remote procedure call (RPC) error code. The RPC call may be unsuccessful due to Wlan RPC server issues, such as when the RPC server is not started. Refer to RPC for more information.

Remarks

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, the parameter is set to FALSE; otherwise, the parameter is set to TRUE.

See Also

Reference

Native Wi-Fi Functions
WlanOpenHandle
WLAN_AUTOCONF_OPCODE
WlanQueryAutoConfigParameter
Native Wi-Fi Reference