Win32 API 日本語リファレンス
ホーム › NetworkManagement.WiFi › WlanGetProfile

WlanGetProfile

関数
指定した無線LANプロファイルのXML内容を取得する。
DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// wlanapi.dll
#include <windows.h>

DWORD WlanGetProfile(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    LPCWSTR strProfileName,
    void* pReserved,   // optional
    LPWSTR* pstrProfileXml,
    DWORD* pdwFlags,   // optional
    DWORD* pdwGrantedAccess   // optional
);

パラメーター

名前型方向説明
hClientHandleHANDLEinクライアントのセッションハンドル。以前の WlanOpenHandle 関数の呼び出しによって取得したものです。
pInterfaceGuidGUID*in

ワイヤレスインターフェイスの GUID。

ローカルコンピューター上のワイヤレスインターフェイスの GUID の一覧は、WlanEnumInterfaces 関数を使用して取得できます。

strProfileNameLPCWSTRin

プロファイルの名前。プロファイル名は大文字と小文字が区別されます。この文字列は NULL で終端されている必要があります。プロファイル名の最大長は 255 文字です。つまり、NULL 終端文字を含めたこの文字列の最大長は 256 文字になります。

Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: プロファイルの名前は、ネットワークの SSID から自動的に導出されます。インフラストラクチャネットワークのプロファイルでは、プロファイル名はネットワークの SSID です。アドホックネットワークのプロファイルでは、プロファイル名はアドホックネットワークの SSID の後に -adhoc を付けたものになります。

pReservedvoid*optional将来の使用のために予約されています。NULL に設定する必要があります。
pstrProfileXmlLPWSTR*out照会したプロファイルの XML 表現である文字列。文字列の長さにあらかじめ定められた上限はありません。
pdwFlagsDWORD*inoutoptional

入力時は、要求に関する追加情報を指定するために使用されるアドレス位置へのポインター。入力時にこのパラメーターが NULL の場合、プロファイルフラグに関する情報は返されません。出力時は、プロファイルフラグを受け取るために使用されるアドレス位置へのポインターです。

Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: ユーザー単位のプロファイルはサポートされていません。このパラメーターは NULL に設定してください。

pdwFlags パラメーターは、次の値を格納するアドレス位置を指すことができます。

値 意味
WLAN_PROFILE_GET_PLAINTEXT_KEY
入力時、このフラグは、呼び出し元がワイヤレスプロファイルから平文のキーを取得しようとしていることを示します。呼び出し元のスレッドが必要な権限を持っている場合、WlanGetProfile 関数は、pstrProfileXml パラメーターが指すバッファーに返されるプロファイルの keyMaterial 要素に平文のキーを返します。

WlanGetProfile の呼び出しで平文のキーを返すには、WLAN_SECURABLE_OBJECT 列挙型の wlan_secure_get_plaintext_key の権限が呼び出し元のスレッドに設定されている必要があります。また、DACL には、呼び出し元スレッドのアクセストークンに WLAN_READ_ACCESS 権限を付与する ACE が含まれている必要があります。既定では、平文のキーを取得する権限は、ローカルコンピューター上の Administrators グループのメンバーにのみ許可されています。

呼び出し元のスレッドに必要な権限がない場合、WlanGetProfile 関数は、pstrProfileXml パラメーターが指すバッファーに返されるプロファイルの keyMaterial 要素に暗号化されたキーを返します。呼び出し元のスレッドに必要な権限がない場合でも、エラーは返されません。

Windows 7: 入力時に渡すこのフラグは、Windows 7 以降で追加されたネイティブワイヤレス API の拡張です。pdwFlags パラメーターは、Windows 7 以降では __inout_opt パラメーターです。

WLAN_PROFILE_GROUP_POLICY
出力時、WlanGetProfile の呼び出しが成功した場合、このフラグは、このプロファイルがグループポリシーによって作成されたことを示します。グループポリシーのプロファイルは読み取り専用です。プロファイルの内容も優先順位も変更できません。
WLAN_PROFILE_USER
出力時、WlanGetProfile の呼び出しが成功した場合、このフラグは、そのプロファイルが、呼び出し元のスレッドが動作しているコンテキストの特定のユーザーに対するユーザープロファイルであることを示します。設定されていない場合、このプロファイルは全ユーザー用のプロファイルです。
pdwGrantedAccessDWORD*outoptional

全ユーザー用プロファイルのアクセスマスク。

値 意味
WLAN_READ_ACCESS
ユーザーはプロファイルの内容を表示できます。
WLAN_EXECUTE_ACCESS
ユーザーは読み取りアクセス権を持ち、さらにそのプロファイルを使用してネットワークへの接続と切断を行えます。ユーザーが WLAN_EXECUTE_ACCESS を持つ場合、そのユーザーは WLAN_READ_ACCESS も持ちます。
WLAN_WRITE_ACCESS
ユーザーは実行アクセス権を持ち、さらにプロファイルの内容を変更したり、プロファイルを削除したりできます。ユーザーが WLAN_WRITE_ACCESS を持つ場合、そのユーザーは WLAN_EXECUTE_ACCESS と WLAN_READ_ACCESS も持ちます。

戻り値の型: DWORD

公式ドキュメント

指定されたワイヤレスプロファイルに関するすべての情報を取得します。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は次のいずれかのリターンコードになることがあります。

リターンコード 説明
ERROR_ACCESS_DENIED
呼び出し元に十分な権限がありません。このエラーは、pstrProfileXml パラメーターが全ユーザー用プロファイルを指定しているにもかかわらず、呼び出し元がそのプロファイルに対する読み取りアクセス権を持っていない場合に返されます。
ERROR_INVALID_HANDLE
ハンドルが無効です。このエラーは、hClientHandle パラメーターで指定されたハンドルがハンドルテーブルに見つからなかった場合に返されます。
ERROR_INVALID_PARAMETER
パラメーターが正しくありません。このエラーは、次のいずれかの条件に該当する場合に返されます。
  • hClientHandle が NULL である。
  • pInterfaceGuid が NULL である。
  • pstrProfileXml が NULL である。
  • pReserved が NULL でない。
ERROR_NOT_ENOUGH_MEMORY
このコマンドを処理するのに十分なストレージがありません。このエラーは、システムがプロファイル用のメモリを割り当てられなかった場合に返されます。
ERROR_NOT_FOUND
strProfileName で指定されたプロファイルが見つかりませんでした。
その他
さまざまな RPC エラーやその他のエラーコード。返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

WlanGetProfile 関数が成功すると、ワイヤレスプロファイルは pstrProfileXml パラメーターが指すバッファーに返されます。このバッファーには、照会したプロファイルの XML 表現である文字列が格納されます。ワイヤレスプロファイルの XML 表現については、WLAN_profile スキーマを参照してください。

pstrProfileXml パラメーターが指すバッファーが不要になったら、そのバッファー用に割り当てられたメモリを解放するために WlanFreeMemory 関数を呼び出す責任は、呼び出し元にあります。

pstrProfileXml が全ユーザー用プロファイルを指定している場合、WlanGetProfile の呼び出し元は、そのプロファイルに対する読み取りアクセス権を持っている必要があります。そうでない場合、WlanGetProfile の呼び出しは ERROR_ACCESS_DENIED を返して失敗します。全ユーザー用プロファイルの権限は、WlanSetProfile または WlanSaveTemporaryProfile を使用してプロファイルを作成または保存するときに設定されます。

Windows 7:

WlanGetProfile 関数の呼び出し時に、pdwFlags パラメーターが指す値に WLAN_PROFILE_GET_PLAINTEXT_KEY フラグを設定して入力すると、pstrProfileXml が指すプロファイルスキーマで返される keyMaterial 要素を平文で要求できます。

WEP キーの場合、プロファイルの作成時または更新時に平文のキーを設定するには、5 文字の ASCII 文字と 10 文字の 16 進数文字のどちらも使用できます。ただし、WEP のプロファイルは、作成時にどちらの入力が使われたかにかかわらず、キーが 10 文字の 16 進数文字で保存されます。そのため、WlanGetProfile 関数が返すプロファイルでは、平文の WEP キーは常に 10 文字の 16 進数文字として返されます。

WlanGetProfile の呼び出しで平文のキーを返すには、WLAN_SECURABLE_OBJECT 列挙型の wlan_secure_get_plaintext_key の権限が呼び出し元のスレッドに設定されている必要があります。また、DACL には、呼び出し元スレッドのアクセストークンに WLAN_READ_ACCESS 権限を付与する ACE が含まれている必要があります。既定では、平文のキーを取得する権限は、ローカルコンピューター上の Administrators グループのメンバーにのみ許可されています。

呼び出し元のスレッドに必要な権限がない場合、WlanGetProfile 関数は、pstrProfileXml パラメーターが指すバッファーに返されるプロファイルの keyMaterial 要素に暗号化されたキーを返します。呼び出し元のスレッドに必要な権限がない場合でも、エラーは返されません。

既定では、pstrProfileXml が指すプロファイルで返される keyMaterial 要素は暗号化されています。プロセスが同じコンピューター上の LocalSystem アカウントのコンテキストで実行されている場合は、CryptUnprotectData 関数を呼び出してキーマテリアルの暗号化を解除できます。

Windows Server 2008 および Windows Vista: pstrProfileXml が指すプロファイルスキーマで返される keyMaterial 要素は常に暗号化されています。プロセスが LocalSystem アカウントのコンテキストで実行されている場合は、CryptUnprotectData 関数を呼び出してキーマテリアルの暗号化を解除できます。

Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: キーマテリアルが暗号化されることはありません。

例

次の例では、ローカルコンピューター上のワイヤレス LAN インターフェイスを列挙し、各ワイヤレス LAN インターフェイスで特定のワイヤレスプロファイルの情報を取得して、取得した値を出力します。照会したプロファイルの XML 表現である文字列も出力します。

メモ この例は、ワイヤレス 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>

// Wlanapi.lib と Ole32.lib をリンクする必要があります
#pragma comment(lib, "wlanapi.lib")
#pragma comment(lib, "ole32.lib")


int _cdecl wmain(int argc, WCHAR **argv)
{

    // 変数を宣言して初期化します。

    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;

    /* WlanEnumInterfaces で使用する変数  */

    PWLAN_INTERFACE_INFO_LIST pIfList = NULL;
    PWLAN_INTERFACE_INFO pIfInfo = NULL;

    LPCWSTR pProfileName = NULL;
    LPWSTR pProfileXml = NULL;
    DWORD dwFlags = 0;
    DWORD dwGrantedAccess = 0;
   
        // パラメーターを検証します。
    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"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;
        // ここで FormatMessage を使用すると、関数が失敗した理由を確認できます。
    }

    dwResult = WlanEnumInterfaces(hClient, NULL, &pIfList);
    if (dwResult != ERROR_SUCCESS) {
        wprintf(L"WlanEnumInterfaces failed with error: %u\n", dwResult);
        return 1;
        // ここで FormatMessage を使用すると、関数が失敗した理由を確認できます。
    } 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\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)); 
            // C++ ではなく C のソースコードの場合、上記の行は次のようにする必要があります。
            // 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\n");

            dwResult = WlanGetProfile(hClient,
                                             &pIfInfo->InterfaceGuid,
                                             pProfileName,
                                             NULL, 
                                             &pProfileXml,
                                             &dwFlags,
                                             &dwGrantedAccess);

            if (dwResult != ERROR_SUCCESS) {
                wprintf(L"WlanGetProfile failed with error: %u\n",
                        dwResult);
                // FormatMessage を使用すると、関数が失敗した理由を確認できます。
            } else {
                wprintf(L"  Profile Name:  %ws\n", pProfileName);

                wprintf(L"  Profile XML string:\n");
                wprintf(L"%ws\n\n", pProfileXml);

                wprintf(L"  dwFlags:\t    0x%x", dwFlags);
//                    if (dwFlags & WLAN_PROFILE_GET_PLAINTEXT_KEY)
//                        wprintf(L"   Get Plain Text Key");
                    if (dwFlags & WLAN_PROFILE_GROUP_POLICY)
                        wprintf(L"  Group Policy");
                    if (dwFlags & WLAN_PROFILE_USER)
                        wprintf(L"  Per User Profile");
                    wprintf(L"\n");    

                wprintf(L"  dwGrantedAccess:  0x%x", dwGrantedAccess);
                if (dwGrantedAccess & WLAN_READ_ACCESS)
                    wprintf(L"  Read access");
                if (dwGrantedAccess & WLAN_EXECUTE_ACCESS)
                    wprintf(L"  Execute access");
                if (dwGrantedAccess & WLAN_WRITE_ACCESS)
                    wprintf(L"  Write access");
                wprintf(L"\n");    

                wprintf(L"\n");
            }
        }

    }
    if (pProfileXml != NULL) {
        WlanFreeMemory(pProfileXml);
        pProfileXml = NULL;
    }

    if (pIfList != NULL) {
        WlanFreeMemory(pIfList);
        pIfList = NULL;
    }

    return dwRetVal;
}
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// wlanapi.dll
#include <windows.h>

DWORD WlanGetProfile(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    LPCWSTR strProfileName,
    void* pReserved,   // optional
    LPWSTR* pstrProfileXml,
    DWORD* pdwFlags,   // optional
    DWORD* pdwGrantedAccess   // optional
);
[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanGetProfile(
    IntPtr hClientHandle,   // HANDLE
    ref Guid pInterfaceGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string strProfileName,   // LPCWSTR
    IntPtr pReserved,   // void* optional
    IntPtr pstrProfileXml,   // LPWSTR* out
    IntPtr pdwFlags,   // DWORD* optional, in/out
    IntPtr pdwGrantedAccess   // DWORD* optional, out
);
<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanGetProfile(
    hClientHandle As IntPtr,   ' HANDLE
    ByRef pInterfaceGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> strProfileName As String,   ' LPCWSTR
    pReserved As IntPtr,   ' void* optional
    pstrProfileXml As IntPtr,   ' LPWSTR* out
    pdwFlags As IntPtr,   ' DWORD* optional, in/out
    pdwGrantedAccess As IntPtr   ' DWORD* optional, out
) As UInteger
End Function
' hClientHandle : HANDLE
' pInterfaceGuid : GUID*
' strProfileName : LPCWSTR
' pReserved : void* optional
' pstrProfileXml : LPWSTR* out
' pdwFlags : DWORD* optional, in/out
' pdwGrantedAccess : DWORD* optional, out
Declare PtrSafe Function WlanGetProfile Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pInterfaceGuid As LongPtr, _
    ByVal strProfileName As LongPtr, _
    ByVal pReserved As LongPtr, _
    ByVal pstrProfileXml As LongPtr, _
    ByVal pdwFlags As LongPtr, _
    ByVal pdwGrantedAccess As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WlanGetProfile = ctypes.windll.wlanapi.WlanGetProfile
WlanGetProfile.restype = wintypes.DWORD
WlanGetProfile.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pInterfaceGuid : GUID*
    wintypes.LPCWSTR,  # strProfileName : LPCWSTR
    ctypes.POINTER(None),  # pReserved : void* optional
    ctypes.c_void_p,  # pstrProfileXml : LPWSTR* out
    ctypes.POINTER(wintypes.DWORD),  # pdwFlags : DWORD* optional, in/out
    ctypes.POINTER(wintypes.DWORD),  # pdwGrantedAccess : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WlanGetProfile = Fiddle::Function.new(
  lib['WlanGetProfile'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pInterfaceGuid : GUID*
    Fiddle::TYPE_VOIDP,  # strProfileName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pstrProfileXml : LPWSTR* out
    Fiddle::TYPE_VOIDP,  # pdwFlags : DWORD* optional, in/out
    Fiddle::TYPE_VOIDP,  # pdwGrantedAccess : DWORD* optional, out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wlanapi")]
extern "system" {
    fn WlanGetProfile(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        pInterfaceGuid: *const GUID,  // GUID*
        strProfileName: *const u16,  // LPCWSTR
        pReserved: *mut (),  // void* optional
        pstrProfileXml: *mut *mut u16,  // LPWSTR* out
        pdwFlags: *mut u32,  // DWORD* optional, in/out
        pdwGrantedAccess: *mut u32  // DWORD* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WlanGetProfile(IntPtr hClientHandle, ref Guid pInterfaceGuid, [MarshalAs(UnmanagedType.LPWStr)] string strProfileName, IntPtr pReserved, IntPtr pstrProfileXml, IntPtr pdwFlags, IntPtr pdwGrantedAccess);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanGetProfile' -Namespace Win32 -PassThru
# $api::WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
#uselib "wlanapi.dll"
#func global WlanGetProfile "WlanGetProfile" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; WlanGetProfile hClientHandle, varptr(pInterfaceGuid), strProfileName, pReserved, varptr(pstrProfileXml), varptr(pdwFlags), varptr(pdwGrantedAccess)   ; 戻り値は stat
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "sptr"
; strProfileName : LPCWSTR -> "sptr"
; pReserved : void* optional -> "sptr"
; pstrProfileXml : LPWSTR* out -> "sptr"
; pdwFlags : DWORD* optional, in/out -> "sptr"
; pdwGrantedAccess : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wlanapi.dll"
#cfunc global WlanGetProfile "WlanGetProfile" sptr, var, wstr, sptr, var, var, var
; res = WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "var"
; strProfileName : LPCWSTR -> "wstr"
; pReserved : void* optional -> "sptr"
; pstrProfileXml : LPWSTR* out -> "var"
; pdwFlags : DWORD* optional, in/out -> "var"
; pdwGrantedAccess : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WlanGetProfile(HANDLE hClientHandle, GUID* pInterfaceGuid, LPCWSTR strProfileName, void* pReserved, LPWSTR* pstrProfileXml, DWORD* pdwFlags, DWORD* pdwGrantedAccess)
#uselib "wlanapi.dll"
#cfunc global WlanGetProfile "WlanGetProfile" intptr, var, wstr, intptr, var, var, var
; res = WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
; hClientHandle : HANDLE -> "intptr"
; pInterfaceGuid : GUID* -> "var"
; strProfileName : LPCWSTR -> "wstr"
; pReserved : void* optional -> "intptr"
; pstrProfileXml : LPWSTR* out -> "var"
; pdwFlags : DWORD* optional, in/out -> "var"
; pdwGrantedAccess : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wlanapi = windows.NewLazySystemDLL("wlanapi.dll")
	procWlanGetProfile = wlanapi.NewProc("WlanGetProfile")
)

// hClientHandle (HANDLE), pInterfaceGuid (GUID*), strProfileName (LPCWSTR), pReserved (void* optional), pstrProfileXml (LPWSTR* out), pdwFlags (DWORD* optional, in/out), pdwGrantedAccess (DWORD* optional, out)
r1, _, err := procWlanGetProfile.Call(
	uintptr(hClientHandle),
	uintptr(pInterfaceGuid),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strProfileName))),
	uintptr(pReserved),
	uintptr(pstrProfileXml),
	uintptr(pdwFlags),
	uintptr(pdwGrantedAccess),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WlanGetProfile(
  hClientHandle: THandle;   // HANDLE
  pInterfaceGuid: PGUID;   // GUID*
  strProfileName: PWideChar;   // LPCWSTR
  pReserved: Pointer;   // void* optional
  pstrProfileXml: PPWideChar;   // LPWSTR* out
  pdwFlags: Pointer;   // DWORD* optional, in/out
  pdwGrantedAccess: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanGetProfile';
result := DllCall("wlanapi\WlanGetProfile"
    , "Ptr", hClientHandle   ; HANDLE
    , "Ptr", pInterfaceGuid   ; GUID*
    , "WStr", strProfileName   ; LPCWSTR
    , "Ptr", pReserved   ; void* optional
    , "Ptr", pstrProfileXml   ; LPWSTR* out
    , "Ptr", pdwFlags   ; DWORD* optional, in/out
    , "Ptr", pdwGrantedAccess   ; DWORD* optional, out
    , "UInt")   ; return: DWORD
●WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess) = DLL("wlanapi.dll", "dword WlanGetProfile(void*, void*, char*, void*, void*, void*, void*)")
# 呼び出し: WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
# hClientHandle : HANDLE -> "void*"
# pInterfaceGuid : GUID* -> "void*"
# strProfileName : LPCWSTR -> "char*"
# pReserved : void* optional -> "void*"
# pstrProfileXml : LPWSTR* out -> "void*"
# pdwFlags : DWORD* optional, in/out -> "void*"
# pdwGrantedAccess : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "wlanapi" fn WlanGetProfile(
    hClientHandle: ?*anyopaque, // HANDLE
    pInterfaceGuid: [*c]GUID, // GUID*
    strProfileName: [*c]const u16, // LPCWSTR
    pReserved: ?*anyopaque, // void* optional
    pstrProfileXml: [*c][*c]u16, // LPWSTR* out
    pdwFlags: [*c]u32, // DWORD* optional, in/out
    pdwGrantedAccess: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) u32;
proc WlanGetProfile(
    hClientHandle: pointer,  # HANDLE
    pInterfaceGuid: ptr GUID,  # GUID*
    strProfileName: WideCString,  # LPCWSTR
    pReserved: pointer,  # void* optional
    pstrProfileXml: ptr WideCString,  # LPWSTR* out
    pdwFlags: ptr uint32,  # DWORD* optional, in/out
    pdwGrantedAccess: ptr uint32  # DWORD* optional, out
): uint32 {.importc: "WlanGetProfile", stdcall, dynlib: "wlanapi.dll".}
pragma(lib, "wlanapi");
extern(Windows)
uint WlanGetProfile(
    void* hClientHandle,   // HANDLE
    GUID* pInterfaceGuid,   // GUID*
    const(wchar)* strProfileName,   // LPCWSTR
    void* pReserved,   // void* optional
    wchar** pstrProfileXml,   // LPWSTR* out
    uint* pdwFlags,   // DWORD* optional, in/out
    uint* pdwGrantedAccess   // DWORD* optional, out
);
ccall((:WlanGetProfile, "wlanapi.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{GUID}, Cwstring, Ptr{Cvoid}, Ptr{Ptr{UInt16}}, Ptr{UInt32}, Ptr{UInt32}),
      hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
# hClientHandle : HANDLE -> Ptr{Cvoid}
# pInterfaceGuid : GUID* -> Ptr{GUID}
# strProfileName : LPCWSTR -> Cwstring
# pReserved : void* optional -> Ptr{Cvoid}
# pstrProfileXml : LPWSTR* out -> Ptr{Ptr{UInt16}}
# pdwFlags : DWORD* optional, in/out -> Ptr{UInt32}
# pdwGrantedAccess : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t WlanGetProfile(
    void* hClientHandle,
    void* pInterfaceGuid,
    const uint16_t* strProfileName,
    void* pReserved,
    uint16_t** pstrProfileXml,
    uint32_t* pdwFlags,
    uint32_t* pdwGrantedAccess);
]]
local wlanapi = ffi.load("wlanapi")
-- wlanapi.WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
-- hClientHandle : HANDLE
-- pInterfaceGuid : GUID*
-- strProfileName : LPCWSTR
-- pReserved : void* optional
-- pstrProfileXml : LPWSTR* out
-- pdwFlags : DWORD* optional, in/out
-- pdwGrantedAccess : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('wlanapi.dll');
const WlanGetProfile = lib.func('__stdcall', 'WlanGetProfile', 'uint32_t', ['void *', 'void *', 'str16', 'void *', 'void *', 'uint32_t *', 'uint32_t *']);
// WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
// hClientHandle : HANDLE -> 'void *'
// pInterfaceGuid : GUID* -> 'void *'
// strProfileName : LPCWSTR -> 'str16'
// pReserved : void* optional -> 'void *'
// pstrProfileXml : LPWSTR* out -> 'void *'
// pdwFlags : DWORD* optional, in/out -> 'uint32_t *'
// pdwGrantedAccess : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("wlanapi.dll", {
  WlanGetProfile: { parameters: ["pointer", "pointer", "buffer", "pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess)
// hClientHandle : HANDLE -> "pointer"
// pInterfaceGuid : GUID* -> "pointer"
// strProfileName : LPCWSTR -> "buffer"
// pReserved : void* optional -> "pointer"
// pstrProfileXml : LPWSTR* out -> "pointer"
// pdwFlags : DWORD* optional, in/out -> "pointer"
// pdwGrantedAccess : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t WlanGetProfile(
    void* hClientHandle,
    void* pInterfaceGuid,
    const uint16_t* strProfileName,
    void* pReserved,
    uint16_t** pstrProfileXml,
    uint32_t* pdwFlags,
    uint32_t* pdwGrantedAccess);
C, "wlanapi.dll");
// $ffi->WlanGetProfile(hClientHandle, pInterfaceGuid, strProfileName, pReserved, pstrProfileXml, pdwFlags, pdwGrantedAccess);
// hClientHandle : HANDLE
// pInterfaceGuid : GUID*
// strProfileName : LPCWSTR
// pReserved : void* optional
// pstrProfileXml : LPWSTR* out
// pdwFlags : DWORD* optional, in/out
// pdwGrantedAccess : DWORD* optional, out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Wlanapi extends StdCallLibrary {
    Wlanapi INSTANCE = Native.load("wlanapi", Wlanapi.class);
    int WlanGetProfile(
        Pointer hClientHandle,   // HANDLE
        Pointer pInterfaceGuid,   // GUID*
        WString strProfileName,   // LPCWSTR
        Pointer pReserved,   // void* optional
        PointerByReference pstrProfileXml,   // LPWSTR* out
        IntByReference pdwFlags,   // DWORD* optional, in/out
        IntByReference pdwGrantedAccess   // DWORD* optional, out
    );
}
@[Link("wlanapi")]
lib Libwlanapi
  fun WlanGetProfile = WlanGetProfile(
    hClientHandle : Void*,   # HANDLE
    pInterfaceGuid : GUID*,   # GUID*
    strProfileName : UInt16*,   # LPCWSTR
    pReserved : Void*,   # void* optional
    pstrProfileXml : UInt16**,   # LPWSTR* out
    pdwFlags : UInt32*,   # DWORD* optional, in/out
    pdwGrantedAccess : UInt32*   # DWORD* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef WlanGetProfileNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Pointer<Utf16>>, Pointer<Uint32>, Pointer<Uint32>);
typedef WlanGetProfileDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, Pointer<Pointer<Utf16>>, Pointer<Uint32>, Pointer<Uint32>);
final WlanGetProfile = DynamicLibrary.open('wlanapi.dll')
    .lookupFunction<WlanGetProfileNative, WlanGetProfileDart>('WlanGetProfile');
// hClientHandle : HANDLE -> Pointer<Void>
// pInterfaceGuid : GUID* -> Pointer<Void>
// strProfileName : LPCWSTR -> Pointer<Utf16>
// pReserved : void* optional -> Pointer<Void>
// pstrProfileXml : LPWSTR* out -> Pointer<Pointer<Utf16>>
// pdwFlags : DWORD* optional, in/out -> Pointer<Uint32>
// pdwGrantedAccess : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function WlanGetProfile(
  hClientHandle: THandle;   // HANDLE
  pInterfaceGuid: PGUID;   // GUID*
  strProfileName: PWideChar;   // LPCWSTR
  pReserved: Pointer;   // void* optional
  pstrProfileXml: PPWideChar;   // LPWSTR* out
  pdwFlags: Pointer;   // DWORD* optional, in/out
  pdwGrantedAccess: Pointer   // DWORD* optional, out
): DWORD; stdcall;
  external 'wlanapi.dll' name 'WlanGetProfile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "WlanGetProfile"
  c_WlanGetProfile :: Ptr () -> Ptr () -> CWString -> Ptr () -> Ptr CWString -> Ptr Word32 -> Ptr Word32 -> IO Word32
-- hClientHandle : HANDLE -> Ptr ()
-- pInterfaceGuid : GUID* -> Ptr ()
-- strProfileName : LPCWSTR -> CWString
-- pReserved : void* optional -> Ptr ()
-- pstrProfileXml : LPWSTR* out -> Ptr CWString
-- pdwFlags : DWORD* optional, in/out -> Ptr Word32
-- pdwGrantedAccess : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let wlangetprofile =
  foreign "WlanGetProfile"
    ((ptr void) @-> (ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> (ptr (ptr uint16_t)) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* hClientHandle : HANDLE -> (ptr void) *)
(* pInterfaceGuid : GUID* -> (ptr void) *)
(* strProfileName : LPCWSTR -> (ptr uint16_t) *)
(* pReserved : void* optional -> (ptr void) *)
(* pstrProfileXml : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* pdwFlags : DWORD* optional, in/out -> (ptr uint32_t) *)
(* pdwGrantedAccess : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library wlanapi (t "wlanapi.dll"))
(cffi:use-foreign-library wlanapi)

(cffi:defcfun ("WlanGetProfile" wlan-get-profile :convention :stdcall) :uint32
  (h-client-handle :pointer)   ; HANDLE
  (p-interface-guid :pointer)   ; GUID*
  (str-profile-name (:string :encoding :utf-16le))   ; LPCWSTR
  (p-reserved :pointer)   ; void* optional
  (pstr-profile-xml :pointer)   ; LPWSTR* out
  (pdw-flags :pointer)   ; DWORD* optional, in/out
  (pdw-granted-access :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $WlanGetProfile = Win32::API::More->new('wlanapi',
    'DWORD WlanGetProfile(HANDLE hClientHandle, LPVOID pInterfaceGuid, LPCWSTR strProfileName, LPVOID pReserved, LPVOID pstrProfileXml, LPVOID pdwFlags, LPVOID pdwGrantedAccess)');
# my $ret = $WlanGetProfile->Call($hClientHandle, $pInterfaceGuid, $strProfileName, $pReserved, $pstrProfileXml, $pdwFlags, $pdwGrantedAccess);
# hClientHandle : HANDLE -> HANDLE
# pInterfaceGuid : GUID* -> LPVOID
# strProfileName : LPCWSTR -> LPCWSTR
# pReserved : void* optional -> LPVOID
# pstrProfileXml : LPWSTR* out -> LPVOID
# pdwFlags : DWORD* optional, in/out -> LPVOID
# pdwGrantedAccess : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目