Share via

WlanSetProfileCustomUserData (Compact 2013)

  • Article

3/26/2014

This function sets the custom user data associated with a profile.

Syntax

DWORD WINAPI WlanSetProfileCustomUserData(
  __in        HANDLE hClientHandle,
  __in        const GUID* pInterfaceGuid,
  __in        LPCWSTR strProfileName,
  __in        DWORD dwDataSize,
  __in_bcount(dwDataSize)  CONST PBYTE pData,
  __reserved  PVOID pReserved
);

Parameters

  • hClientHandle
    [in] Handle to the session on the client. To obtain a handle, call the WlanOpenHandle function.
  • pInterfaceGuid
    [in] GUID of the interface.
  • strProfileName
    [in] Name of the profile associated with the custom user data. Profile names are case-sensitive and the string must be NULL-terminated.
  • dwDataSize
    [in] Size of pData, in bytes.
  • pData
    [in] Pointer to the user data to be set.
  • pReserved
    Reserved; set to NULL.

Return Values

Value

Description

ERROR_SUCCESS

The function succeeds.

ERROR_ACCESS_DENIED

You included Connection Manager in your OS.

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • hClientHandle is NULL or invalid.
  • pInterfaceGuid is NULL.
  • strProfileName is NULL.
  • pReserved is not NULL.
  • dwDataSize is not 0 and pData 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.

RPC_STATUS

Can be any Remote Procedure Call (RPC) error code. The RPC call may be unsuccessful due to Wlan RPC server issues, such as when the RPC server is not started. Refer to RPC for more information.

Remarks

If you include Connection Manager in your OS design:

See Also

Reference

Native Wi-Fi Functions
WlanOpenHandle
WlanGetProfileCustomUserData
Native Wi-Fi Reference