TwclWiFiProfilesManager.GetProfileUserData(TGUID,string,Cardinal,PByte) Method

The method gets the custom user data associated with a wireless profile.

Namespace: wclWiFi
Delphi
public
 function GetProfileUserData(const IfaceId: TGUID; const ProfileName: string;
 out DataSize: Cardinal; out Data: PByte): Integer;

Parameters

IfaceId
Type: TGUID

The ID of the wireless LAN interface.

ProfileName
Type: string

The name of the profile with which the custom user data is associated. Profile names are case-sensitive.

DataSize
Type: Cardinal

The size, in bytes, of the user data buffer pointed to by the Data parameter.

Data
Type: PByte

A pointer to the user data.

Return Value

Type: Integer

If the function succeeds, the return value is wclErrors.WCL_E_SUCCESS. If the function fails, the return value may be one of the WCL return codes.

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 SetProfileUserData method. The custom user data gets reset to empty any time the profile is modified by calling the SetProfile method.

Once custom user data has been set, this data can be accessed using the GetProfileUserData method.

The caller is responsible for freeing the memory allocated for the buffer pointed to by the Data parameter using the FreeMemory method.