WlanGetInterfaceCapability function (wlanapi.h)

  • Article

The WlanGetInterfaceCapability function retrieves the capabilities of an interface.

Syntax

DWORD WlanGetInterfaceCapability(
  [in]  HANDLE                     hClientHandle,
  [in]  const GUID                 *pInterfaceGuid,
        PVOID                      pReserved,
  [out] PWLAN_INTERFACE_CAPABILITY *ppCapability
);

Parameters

[in] hClientHandle

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

[in] pInterfaceGuid

The GUID of this interface.

pReserved

Reserved for future use. Must be set to NULL.

[out] ppCapability

A WLAN_INTERFACE_CAPABILITY structure that contains information about the capabilities of the specified interface.

Return value

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_PARAMETER
 hClientHandle is NULL or invalid, pInterfaceGuid is NULL, pReserved is not NULL, or ppCapability 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. 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.
RPC_STATUS
 Various error codes.

Remarks

The caller is responsible for calling the WlanFreeMemory function to free the memory allocated to ppCapability.

Requirements

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