DOT11EXT_GET_PROFILE_CUSTOM_USER_DATA callback function (wlanihv.h)
Syntax
DOT11EXT_GET_PROFILE_CUSTOM_USER_DATA Dot11extGetProfileCustomUserData;
DWORD Dot11extGetProfileCustomUserData(
[in, optional] HANDLE hDot11SvcHandle,
[in, optional] HANDLE hConnectSession,
[in] DWORD dwSessionID,
[out] DWORD *pdwDataSize,
[out] LPVOID *ppvData
)
{...}
Parameters
[in, optional] hDot11SvcHandle
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.
[in, optional] hConnectSession
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.
[in] dwSessionID
The session identifier (session ID) of the current user.
[out] pdwDataSize
A pointer to a caller-supplied variable that stores the size, in bytes, of the buffer referenced by ppvData .
[out] ppvData
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
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows Vista and later versions of the Windows operating systems. |
| Target Platform | Desktop |
| Header | wlanihv.h (include Wlanihv.h) |