WlanGetProfileList (Compact 2013)
3/26/2014
This function retrieves the list of profiles in preference order.
Syntax
DWORD WINAPI WlanGetProfileList(
__in HANDLE hClientHandle,
__in const GUID* pInterfaceGuid,
__reserved PVOID pReserved,
__deref__out PWLAN_PROFILE_INFO_LIST* ppProfileList
);
Parameters
- hClientHandle
[in] Handle to the session on the client. To obtain a handle, call the WlanOpenHandle function.
- pInterfaceGuid
[in] GUID of the interface.
- pReserved
Reserved; set to NULL.
- ppProfileList
[out] WLAN_PROFILE_INFO_LIST structure that contains the list of profile information.
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:
|
ERROR_INVALID_HANDLE |
The handle hClientHandle was not found in the handle table. |
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. |
ERROR_NOT_ENOUGH_MEMORY |
Could not allocate memory for the profile list. |
Remarks
If you include Connection Manager in your OS design:
- You must handle Wi-Fi connection operations using Connection Manager APIs such as CmAcquireConnection, CmAddConnectionConfig, or CmReleaseConnection.
- Otherwise, if you use this API, it returns ERROR_ACCESS_DENIED.
This function returns only the basic information about the profiles. You can retrieve the full content of a profile by using the WlanGetProfile function.
This function allocates memory. To free the memory, you must call the WlanFreeMemory function.
See Also
Reference
Native Wi-Fi Functions
WlanOpenHandle
WlanGetProfile
WlanFreeMemory
WLAN_PROFILE_INFO_LIST
WlanSetProfileList
Native Wi-Fi Reference