ホーム › NetworkManagement.WiFi › WlanSetProfilePosition

WlanSetProfilePosition

関数

指定した無線LANプロファイルの優先順位の位置を設定する。

DLLwlanapi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD WlanSetProfilePosition(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    LPCWSTR strProfileName,
    DWORD dwPosition,
    void* pReserved   // optional
);

パラメーター

名前	型	方向	説明
hClientHandle	HANDLE	in	クライアントのセッションハンドル。事前に WlanOpenHandle 関数を呼び出して取得します。
pInterfaceGuid	GUID*	in	インターフェイスの GUID。
strProfileName	LPCWSTR	in	プロファイルの名前。プロファイル名では大文字と小文字が区別されます。この文字列は NULL で終端されている必要があります。 Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: 指定する名前は、ネットワークの SSID から自動的に導出されるプロファイル名と一致している必要があります。インフラストラクチャネットワークのプロファイルの場合は、プロファイル名として SSID を指定する必要があります。アドホックネットワークのプロファイルの場合は、指定する名前はアドホックネットワークの SSID の後に `-adhoc` を付加したものである必要があります。
dwPosition	DWORD	in	プロファイルの移動先となる、優先順位リスト内の位置を示します。0 (ゼロ) は、WlanGetProfileList 関数が返すリストの先頭のプロファイルに対応します。
pReserved	void*	optional	将来の使用のために予約されています。NULL を設定する必要があります。

戻り値の型: DWORD

公式ドキュメント

優先順位リスト内で、指定した 1 つのプロファイルの位置を設定します。

戻り値

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

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

リターンコード	説明
ERROR_ACCESS_DENIED	呼び出し元に、プロファイルの位置を変更するための十分なアクセス許可がありません。 WlanSetProfilePosition は、プロファイルリスト内の全ユーザープロファイルの相対的な順序を変更する操作、または全ユーザープロファイルをプロファイルリスト内のより後ろの位置へ移動する操作を実行する前に、wlan_secure_all_user_profiles_order オブジェクトと共に格納されている随意アクセス制御リスト (DACL) を取得します。DACL に、呼び出し元スレッドのアクセストークンに対して WLAN_WRITE_ACCESS 権限を許可するアクセス制御エントリ (ACE) が含まれていない場合、WlanSetProfilePosition は ERROR_ACCESS_DENIED を返します。
ERROR_INVALID_PARAMETER	hClientHandle が NULL または無効である、pInterfaceGuid が NULL である、strProfileName が NULL である、または pReserved が NULL ではありません。
ERROR_INVALID_HANDLE	ハンドル hClientHandle がハンドルテーブル内に見つかりませんでした。
RPC_STATUS	さまざまなエラーコード。

解説(Remarks)

グループポリシープロファイルの位置は変更できません。

既定では、Administrators グループのメンバーとしてログオンしたユーザーのみが、全ユーザープロファイルの位置を変更できます。全ユーザープロファイルの位置を変更するために実際に必要なユーザー権利を確認するには、WlanGetSecuritySettings を呼び出してください。

コマンドラインでプロファイルの位置を設定するには、netsh wlan set profileorder コマンドを使用します。詳細については、ワイヤレスローカルエリアネットワーク (wlan) 用の Netsh コマンドを参照してください。

Windows XP with SP3 および Wireless LAN API for Windows XP with SP2: アドホックプロファイルは、プロファイルリスト内でインフラストラクチャプロファイルの後に表示されます。WlanSetProfilePosition を使用してアドホックプロファイルをインフラストラクチャプロファイルより前に配置しようとした場合、WlanSetProfilePosition の呼び出しは成功しますが、Wireless Zero Configuration サービスがプロファイルリストの順序を変更し、アドホックプロファイルはすべてのインフラストラクチャネットワークプロファイルの後に配置されます。

ゲストプロファイル、Wireless Provisioning Service (WPS) 認証を使用するプロファイル、および Wi-Fi Protected Access-None (WPA-None) 認証を使用するプロファイルはサポートされていません。これらのプロファイルが優先プロファイルリストに表示される場合、そのプロファイルはリスト内で固定された位置を持ちます。つまり、WlanSetProfilePosition を使用してその位置を変更することはできず、また他のプロファイルの位置変更の影響も受けません。

すべてのワイヤレス LAN 関数は、プロファイル操作を実行する際に、ワイヤレスインターフェイスのインターフェイス GUID を必要とします。ワイヤレスインターフェイスが取り外されると、その状態は Wireless LAN Service (WLANSVC) からクリアされ、プロファイル操作は一切実行できなくなります。

pInterfaceGuid パラメーターで指定したワイヤレスインターフェイスがシステムから取り外されている場合 (たとえば USB ワイヤレスアダプターが取り外された場合)、WlanSetProfilePosition 関数は ERROR_INVALID_PARAMETER で失敗することがあります。

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

各言語での呼び出し定義

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

DWORD WlanSetProfilePosition(
    HANDLE hClientHandle,
    const GUID* pInterfaceGuid,
    LPCWSTR strProfileName,
    DWORD dwPosition,
    void* pReserved   // optional
);

[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanSetProfilePosition(
    IntPtr hClientHandle,   // HANDLE
    ref Guid pInterfaceGuid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] string strProfileName,   // LPCWSTR
    uint dwPosition,   // DWORD
    IntPtr pReserved   // void* optional
);

<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanSetProfilePosition(
    hClientHandle As IntPtr,   ' HANDLE
    ByRef pInterfaceGuid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> strProfileName As String,   ' LPCWSTR
    dwPosition As UInteger,   ' DWORD
    pReserved As IntPtr   ' void* optional
) As UInteger
End Function

' hClientHandle : HANDLE
' pInterfaceGuid : GUID*
' strProfileName : LPCWSTR
' dwPosition : DWORD
' pReserved : void* optional
Declare PtrSafe Function WlanSetProfilePosition Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pInterfaceGuid As LongPtr, _
    ByVal strProfileName As LongPtr, _
    ByVal dwPosition As Long, _
    ByVal pReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WlanSetProfilePosition = ctypes.windll.wlanapi.WlanSetProfilePosition
WlanSetProfilePosition.restype = wintypes.DWORD
WlanSetProfilePosition.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pInterfaceGuid : GUID*
    wintypes.LPCWSTR,  # strProfileName : LPCWSTR
    wintypes.DWORD,  # dwPosition : DWORD
    ctypes.POINTER(None),  # pReserved : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WlanSetProfilePosition = Fiddle::Function.new(
  lib['WlanSetProfilePosition'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pInterfaceGuid : GUID*
    Fiddle::TYPE_VOIDP,  # strProfileName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwPosition : DWORD
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wlanapi")]
extern "system" {
    fn WlanSetProfilePosition(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        pInterfaceGuid: *const GUID,  // GUID*
        strProfileName: *const u16,  // LPCWSTR
        dwPosition: u32,  // DWORD
        pReserved: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WlanSetProfilePosition(IntPtr hClientHandle, ref Guid pInterfaceGuid, [MarshalAs(UnmanagedType.LPWStr)] string strProfileName, uint dwPosition, IntPtr pReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanSetProfilePosition' -Namespace Win32 -PassThru
# $api::WlanSetProfilePosition(hClientHandle, pInterfaceGuid, strProfileName, dwPosition, pReserved)

#uselib "wlanapi.dll"
#func global WlanSetProfilePosition "WlanSetProfilePosition" sptr, sptr, sptr, sptr, sptr
; WlanSetProfilePosition hClientHandle, varptr(pInterfaceGuid), strProfileName, dwPosition, pReserved   ; 戻り値は stat
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "sptr"
; strProfileName : LPCWSTR -> "sptr"
; dwPosition : DWORD -> "sptr"
; pReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wlanapi.dll"
#cfunc global WlanSetProfilePosition "WlanSetProfilePosition" sptr, var, wstr, int, sptr
; res = WlanSetProfilePosition(hClientHandle, pInterfaceGuid, strProfileName, dwPosition, pReserved)
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "var"
; strProfileName : LPCWSTR -> "wstr"
; dwPosition : DWORD -> "int"
; pReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wlanapi.dll"
#cfunc global WlanSetProfilePosition "WlanSetProfilePosition" sptr, sptr, wstr, int, sptr
; res = WlanSetProfilePosition(hClientHandle, varptr(pInterfaceGuid), strProfileName, dwPosition, pReserved)
; hClientHandle : HANDLE -> "sptr"
; pInterfaceGuid : GUID* -> "sptr"
; strProfileName : LPCWSTR -> "wstr"
; dwPosition : DWORD -> "int"
; pReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。