Partager via

WlanQueryAutoConfigParameter (Compact 2013)

  • Article

3/26/2014

This function queries for the parameters of the auto configuration service.

Syntax

DWORD WINAPI WlanQueryAutoConfigParameter(
  __in        HANDLE hClientHandle,
  __in        WLAN_AUTOCONF_OPCODE OpCode,
  __reserved  PVOID pReserved,
  __out       PDWORD pdwDataSize,
  __out       PVOID ppData,
  __out_opt   PWLAN_OPCODE_VALUE_TYPE pWlanOpcodeValueType
);

Parameters

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

  • OpCode
    WLAN_AUTOCONF_OPCODE value that specifies the parameter to be queried. Possible values are as follows:

    Value

    Meaning

    wlan_autoconf_opcode_show_denied_networks

    When set, the ppData parameter contains a BOOL value that designates whether user-denied networks will be included in the available networks list.

    wlan_autoconf_opcode_power_setting

    When set, the ppData parameter contains a WLAN_POWER_SETTING value that designates the power settings.
  • pReserved
    Reserved; set to NULL.
  • pdwDataSize
    Specifies the size of the ppData parameter, in bytes.

  • ppData
    Pointer to the memory that contains the queried value for the parameter specified in OpCode.

    Note   If OpCode is set to wlan_autoconf_opcode_show_denied_networks, the pointer referenced by ppData may point to an integer value. If the pointer referenced by ppData points to 0, the integer value should be converted to the Boolean value FALSE. If the pointer referenced by ppData points to a non-zero integer, the integer value should be converted to the Boolean value TRUE.

Return Values

Value

Description

ERROR_SUCCESS

The function succeeds.

ERROR_ACCESS_DENIED

The caller does not have sufficient permissions to perform this operation.

ERROR_INVALID_PARAMETER

hClientHandle is NULL or invalid, pReserved is not NULL, ppData is NULL, or pdwDataSize is NULL.

ERROR_INVALID_HANDLE

The handle hClientHandle was not found in the handle table.

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

This function allocates memory for the list of returned interfaces. The caller is responsible for freeing this memory by using the WlanFreeMemory function.

See Also

Reference

Native Wi-Fi Functions
WlanOpenHandle
WLAN_AUTOCONF_OPCODE
WLAN_POWER_SETTING
WLAN_OPCODE_VALUE_TYPE
WlanQueryAutoConfigParameter
WlanFreeMemory
Native Wi-Fi Reference