WlanGetProfileCustomUserData 함수(wlanapi.h)
WlanGetProfileCustomUserData 함수는 무선 프로필과 연결된 사용자 지정 사용자 데이터를 가져옵니다.
구문
DWORD WlanGetProfileCustomUserData(
[in] HANDLE hClientHandle,
[in] const GUID *pInterfaceGuid,
[in] LPCWSTR strProfileName,
PVOID pReserved,
[out] DWORD *pdwDataSize,
[out] PBYTE *ppData
);
매개 변수
[in] hClientHandle
WlanOpenHandle 함수에 대한 이전 호출에서 얻은 클라이언트의 세션 핸들입니다.
[in] pInterfaceGuid
무선 LAN 인터페이스의 GUID에 대한 포인터입니다.
[in] strProfileName
사용자 지정 사용자 데이터가 연결된 프로필의 이름입니다. 프로필 이름은 대/소문자를 구분합니다. 이 문자열은 NULL로 종료되어야 합니다.
pReserved
다음에 사용하도록 예약됩니다. NULL로 설정해야 합니다.
[out] pdwDataSize
ppData 매개 변수가 가리키는 사용자 데이터 버퍼의 크기(바이트)입니다.
[out] ppData
사용자 데이터에 대한 포인터입니다.
반환 값
함수가 성공하면 반환 값이 ERROR_SUCCESS.
함수가 실패하면 반환 값은 다음 반환 코드 중 하나일 수 있습니다.
| 반환 코드 | 설명 |
|---|---|
|
시스템은 지정된 파일을 찾을 수 없습니다. 이 오류는 지정된 프로필에 대한 사용자 지정 데이터가 없는 경우 반환됩니다. |
|
hClientHandle 매개 변수가 NULL이거나 유효하지 않거나, pInterfaceGuid 매개 변수가 NULL이거나, strProfileName 매개 변수가 NULL이거나, pReserved 매개 변수가 NULL이 아니거나, pdwDataSize 매개 변수가 0이거나, ppData 매개 변수가 NULL입니다. |
|
시스템은 지정된 파일을 찾을 수 없습니다. 지정된 프로필에 대한 사용자 지정 사용자 데이터가 없는 경우 이 오류가 반환됩니다. |
|
핸들 테이블에서 hClientHandle 핸들을 찾을 수 없습니다. |
|
이 함수는 지원되지 않는 플랫폼에서 호출되었습니다. SP3이 있는 Windows XP 또는 SP2 클라이언트를 사용하는 Windows XP용 무선 LAN API에서 이 함수가 호출된 경우 이 값이 반환됩니다. |
|
다양한 오류 코드. |
설명
네이티브 Wifi AutoConfig 서비스에서 사용하는 모든 무선 WLAN 프로필에 대해 Windows는 사용자 지정 사용자 데이터의 개념을 유지 관리합니다. 이 사용자 지정 사용자 데이터는 처음에는 존재하지 않지만 WlanSetProfileCustomUserData 함수를 호출하여 설정할 수 있습니다. WlanSetProfile 함수를 호출하여 프로필이 수정될 때마다 사용자 지정 사용자 데이터가 비워지도록 다시 설정됩니다.
사용자 지정 사용자 데이터가 설정되면 WlanGetProfileCustomUserData 함수를 사용하여 이 데이터에 액세스할 수 있습니다.
호출자는 WlanFreeMemory 함수를 사용하여 ppData 매개 변수가 가리키는 버퍼에 할당된 메모리를 해제합니다.
예제
다음 예제에서는 로컬 컴퓨터에서 무선 LAN 인터페이스를 열거한 다음 각 무선 LAN 인터페이스에서 특정 무선 프로필에 대한 사용자 지정 사용자 데이터 정보를 검색하려고 시도합니다. 사용자 지정 데이터의 크기가 인쇄됩니다.
참고 무선 LAN 서비스가 설치되어 시작되지 않은 경우 이 예제는 Windows Server 2008 및 Windows Server 2008 R2에서 로드되지 않습니다.
#ifndef UNICODE
#define UNICODE
#endif
#include <windows.h>
#include <wlanapi.h>
#include <objbase.h>
#include <wtypes.h>
#include <stdio.h>
#include <stdlib.h>
// Need to link with Wlanapi.lib and Ole32.lib
#pragma comment(lib, "wlanapi.lib")
#pragma comment(lib, "ole32.lib")
int _cdecl wmain(int argc, WCHAR **argv)
{
// Declare and initialize variables.
HANDLE hClient = NULL;
DWORD dwMaxClient = 2; //
DWORD dwCurVersion = 0;
DWORD dwResult = 0;
DWORD dwRetVal = 0;
int iRet = 0;
WCHAR GuidString[39] = {0};
unsigned int i;
/* variables used for WlanEnumInterfaces */
PWLAN_INTERFACE_INFO_LIST pIfList = NULL;
PWLAN_INTERFACE_INFO pIfInfo = NULL;
LPCWSTR pProfileName = NULL;
PBYTE pProfileData = NULL;
DWORD dwDataSize = 0;
// Validate the parameters
if (argc < 2) {
wprintf(L"usage: %s <profile>\n", argv[0]);
wprintf(L" Gets a wireless profile\n");
wprintf(L" Example\n");
wprintf(L" %s \"Default Wireless\"\n", argv[0]);
exit(1);
}
pProfileName = argv[1];
wprintf(L"Custom user data information for profile: %ws\n\n", pProfileName);
dwResult = WlanOpenHandle(dwMaxClient, NULL, &dwCurVersion, &hClient);
if (dwResult != ERROR_SUCCESS) {
wprintf(L"WlanOpenHandle failed with error: %u\n", dwResult);
return 1;
// You can use FormatMessage here to find out why the function failed
}
dwResult = WlanEnumInterfaces(hClient, NULL, &pIfList);
if (dwResult != ERROR_SUCCESS) {
wprintf(L"WlanEnumInterfaces failed with error: %u\n", dwResult);
return 1;
// You can use FormatMessage here to find out why the function failed
} else {
wprintf(L"WLAN_INTERFACE_INFO_LIST for this system\n");
wprintf(L"Num Entries: %lu\n", pIfList->dwNumberOfItems);
wprintf(L"Current Index: %lu\n", pIfList->dwIndex);
for (i = 0; i < (int) pIfList->dwNumberOfItems; i++) {
pIfInfo = (WLAN_INTERFACE_INFO *) &pIfList->InterfaceInfo[i];
wprintf(L" Interface Index[%u]:\t %lu\n", i, i);
iRet = StringFromGUID2(pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString,
sizeof(GuidString)/sizeof(*GuidString));
// For c rather than C++ source code, the above line needs to be
// iRet = StringFromGUID2(&pIfInfo->InterfaceGuid, (LPOLESTR) &GuidString,
// sizeof(GuidString)/sizeof(*GuidString));
if (iRet == 0)
wprintf(L"StringFromGUID2 failed\n");
else {
wprintf(L" InterfaceGUID[%d]: %ws\n",i, GuidString);
}
wprintf(L" Interface Description[%d]: %ws", i,
pIfInfo->strInterfaceDescription);
wprintf(L"\n");
wprintf(L" Interface State[%d]:\t ", i);
switch (pIfInfo->isState) {
case wlan_interface_state_not_ready:
wprintf(L"Not ready\n");
break;
case wlan_interface_state_connected:
wprintf(L"Connected\n");
break;
case wlan_interface_state_ad_hoc_network_formed:
wprintf(L"First node in a ad hoc network\n");
break;
case wlan_interface_state_disconnecting:
wprintf(L"Disconnecting\n");
break;
case wlan_interface_state_disconnected:
wprintf(L"Not connected\n");
break;
case wlan_interface_state_associating:
wprintf(L"Attempting to associate with a network\n");
break;
case wlan_interface_state_discovering:
wprintf(L"Auto configuration is discovering settings for the network\n");
break;
case wlan_interface_state_authenticating:
wprintf(L"In process of authenticating\n");
break;
default:
wprintf(L"Unknown state %ld\n", pIfInfo->isState);
break;
}
wprintf(L"\n");
dwResult = WlanGetProfileCustomUserData(hClient,
&pIfInfo->InterfaceGuid,
pProfileName,
NULL,
&dwDataSize,
&pProfileData);
if (dwResult != ERROR_SUCCESS) {
wprintf(L"WlanGetProfileCustomData failed with error: %u\n",
dwResult);
// You can use FormatMessage to find out why the function failed
} else {
wprintf(L"Profile Name: %ws\n", pProfileName);
wprintf(L" dwDataSize:\t 0x%x\n", dwDataSize);
wprintf(L" Profile Custom Data:\n");
// wprintf(L"%ws\n\n", pProfileXml);
wprintf(L"\n");
wprintf(L"\n");
}
}
}
if (pProfileData != NULL) {
WlanFreeMemory(pProfileData);
pProfileData = NULL;
}
if (pIfList != NULL) {
WlanFreeMemory(pIfList);
pIfList = NULL;
}
return dwRetVal;
}
요구 사항
| 요구 사항 | 값 |
|---|---|
| 지원되는 최소 클라이언트 | Windows Vista [데스크톱 앱만 해당] |
| 지원되는 최소 서버 | Windows Server 2008 [데스크톱 앱만 해당] |
| 대상 플랫폼 | Windows |
| 헤더 | wlanapi.h(Wlanapi.h 포함) |
| 라이브러리 | Wlanapi.lib |
| DLL | Wlanapi.dll |