Dot11ExtGetProfileCustomUserData function

The IHV Extensions DLL calls the Dot11ExtGetProfileCustomUserData function to retrieve data from the system registry specific to the current user and network profile used for the basic service set (BSS) network connection.

Syntax


DWORD APIENTRY Dot11ExtGetProfileCustomUserData(
  _In_opt_  HANDLE hDot11SvcHandle,
  _In_opt_  HANDLE hConnectSession,
  _In_      DWORD dwSessionID,
  _Out_     DWORD *pdwDataSize,
  _Out_     LPVOID *ppvData
);

Parameters

hDot11SvcHandle [in, optional]

The handle used by the operating system to reference the wireless LAN (WLAN) adapter. This handle value was specified through a previous call to the Dot11ExtIhvInitAdapter IHV Handler function.

hConnectSession [in, optional]

The handle used by the operating system to reference the connection session with the basic service set (BSS) network. This handle value was specified through a previous call to the Dot11ExtIhvPerformPreAssociate IHV Handler function.

dwSessionID [in]

The session identifier (session ID) of the current user.

pdwDataSize [out]

A pointer to a caller-supplied variable that stores the size, in bytes, of the buffer referenced by ppvData .

ppvData [out]

The address of a pointer variable that stores the address of the buffer containing the user data.

Return value

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

Remarks

The operating system does not decrypt the data referenced by the ppvData parameter after reading it from the system registry. The IHV Extensions DLL should use its own decryption algorithm to decrypt the data after calling Dot11ExtGetProfileCustomUserData.

For every wireless WLAN profile used by the Native Wifi AutoConfig service, Windows maintains the concept of custom user data. This custom user data is initially non-existent, but can be set by calling the Dot11ExtSetProfileCustomUserData function. The custom user data gets reset to empty any time the profile is modified by calling the Dot11ExtSetCurrentProfile function.

After custom user data has been set, this data can be accessed using the Dot11ExtGetProfileCustomUserData function.

The caller is responsible for freeing the memory allocated for the buffer pointed to by the ppvData parameter using the Dot11ExtFreeBuffer function.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Wlanihv.h (include Wlanihv.h)

See also

Dot11ExtFreeBuffer
Dot11ExtIhvInitAdapter
Dot11ExtIhvPerformPreAssociate
Dot11ExtSetCurrentProfile
Dot11ExtSetProfileCustomUserData

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft