Share via


Dot11ExtIhvQueryUIRequest (Compact 2013)

3/26/2014

The operating system calls this function when the connection status changes. When this function is called, the IHV Extensions DLL returns a DOT11EXT_IHV_UI_REQUEST structure that the operating system can use for a UI request.

Syntax

DWORD WINAPI Dot11ExtIhvQueryUIRequest(
    HANDLE hIhvExtAdapter,
    DOT11EXT_IHV_CONNECTION_PHASE connectionPhase,
    PDOT11EXT_IHV_UI_REQUEST* ppIhvUIRequest
);

Parameters

  • hIhvExtAdapter
    [in] The handle that is used by the IHV Extensions DLL to reference the WLAN adapter. This handle value was specified through a previous call to the Dot11ExtIhvInitAdapter IHV Handler function.
  • connectionPhase
    [in] The current connection phase. The data type for this member is the DOT11EXT_IHV_CONNECTION_PHASE enumeration:

    connection_phase_any

    Specifies any connection phase.

    connection_phase_initial_connection

    Specifies the connection phase before the IHV Extensions DLL starts a pre-association operation.

    connection_phase_post_l3_connection

    Specifies the connection phase after the IHV Extensions DLL finishes a post-association operation.

  • ppIhvUIRequest
    [out] The address of a pointer to a DOT11EXT_IHV_UI_REQUEST structure. The IHV Extensions DLL must allocate a buffer for the DOT11EXT_IHV_UI_REQUEST structure by calling Dot11ExtAllocateBuffer.

Return Value

If the call succeeds, the function returns ERROR_SUCCESS. Otherwise, it returns an error code defined in Winerror.h.

Remarks

When Dot11ExtIhvQueryUIRequest is called, the IHV Extensions DLL must allocate and return a buffer formatted as a DOT11EXT_IHV_UI_REQUEST structure. In this situation, the DLL must follow these guidelines:

  • The IHV Extensions DLL must call Dot11ExtAllocateBuffer to allocate the buffer. After the DLL returns from Dot11ExtIhvQueryUIRequest, the operating system is responsible for calling Dot11ExtFreeBuffer to free the buffer.
  • The IHV Extensions DLL formats the DOT11EXT_IHV_UI_REQUEST structure for a UI request appropriate for the change in connection status.
    For example, if connectionPhase is set to connection_phase_initial_connection, the IHV Extensions DLL could set the members of the DOT11EXT_IHV_UI_REQUEST structure to reference a user interface page that notifies the user of the start of the connection operation.

Requirements

Header

wlanihv.h

See Also

Reference

Native 802.11 IHV Handler Functions
DOT11EXT_IHV_UI_REQUEST
Dot11ExtIhvInitAdapter
Dot11ExtAllocateBuffer
Dot11ExtFreeBuffer
Native 802.11 IHV Extensions DLL