ホーム › NetworkManagement.WiFi › WlanHostedNetworkForceStart

WlanHostedNetworkForceStart

関数

ホストネットワークを参照カウントに関係なく強制的に開始する。

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

シグネチャ

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

DWORD WlanHostedNetworkForceStart(
    HANDLE hClientHandle,
    WLAN_HOSTED_NETWORK_REASON* pFailReason,   // optional
    void* pvReserved   // optional
);

パラメーター

名前	型	方向	説明
hClientHandle	HANDLE	in	クライアントのセッションハンドル。WlanOpenHandle 関数の以前の呼び出しによって返されたものです。
pFailReason	WLAN_HOSTED_NETWORK_REASON*	outoptional	WlanHostedNetworkForceStart 関数の呼び出しが失敗した場合に、失敗の理由を受け取る値への省略可能なポインター。失敗の理由として取り得る値は、Wlanapi.h ヘッダーファイルで定義されている WLAN_HOSTED_NETWORK_REASON 列挙型の値です。
pvReserved	void*	optional	将来の使用のために予約されています。このパラメーターは NULL でなければなりません。

戻り値の型: DWORD

公式ドキュメント

ワイヤレス Hosted Network を、要求をアプリケーションの呼び出し元ハンドルに関連付けることなく wlan_hosted_network_active 状態に遷移させます。

戻り値

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

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

リターンコード	説明
ERROR_ACCESS_DENIED	呼び出し元に十分なアクセス許可がありません。
ERROR_INVALID_HANDLE	ハンドルが無効です。このエラーは、hClientHandle パラメーターで指定されたハンドルがハンドルテーブルに見つからなかった場合に返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、次のいずれかの条件に該当する場合に返されます。 hClientHandle が NULL である。 pvReserved が NULL ではない。
ERROR_INVALID_STATE	要求された操作を実行できる正しい状態にリソースがありません。このエラーは、ワイヤレス Hosted Network がドメインのグループポリシーによって無効にされている場合に返されます。
ERROR_SERVICE_NOT_ACTIVE	サービスが開始されていません。このエラーは、WLAN AutoConfig サービスが実行されていない場合に返されます。
その他	各種の RPC エラーコードおよびその他のエラーコード。返されたエラーのメッセージ文字列を取得するには FormatMessage を使用します。

解説(Remarks)

WlanHostedNetworkForceStart 関数は、Windows 7 および Wireless LAN Service がインストールされた Windows Server 2008 R2 でワイヤレス Hosted Network をサポートするために追加された、ネイティブワイヤレス API の拡張です。

クライアントアプリケーションは、WlanHostedNetworkForceStart 関数を呼び出すことで、要求をアプリケーションの呼び出し元ハンドルに関連付けることなくワイヤレス Hosted Network を wlan_hosted_network_active 状態へ遷移させ、ワイヤレス Hosted Network の開始を強制します。WlanHostedNetworkForceStart 関数の呼び出しが成功した場合は、最終的に WlanHostedNetworkForceStop 関数の呼び出しと対にする必要があります。この関数によって生じた Hosted Network の状態変更は、呼び出し元アプリケーションが呼び出し元ハンドルを閉じても (hClientHandle パラメーターを指定して WlanCloseHandle を呼び出した場合)、またはプロセスが終了しても、自動的には元に戻されません。

WlanHostedNetworkStartUsing の呼び出しに対して WlanHostedNetworkForceStart 関数を呼び出す際のコストは、関連付けられた特権が必要になる点です。アプリケーションは、ワイヤレス Hosted Network を長時間実行することに伴う電力消費の増加を昇格されたシステムユーザーが受け入れたことを確認したうえで、WlanHostedNetworkForceStart 関数を呼び出すことが考えられます。

WlanHostedNetworkForceStart 関数は、Hosted Network の状態が wlan_hosted_network_unavailable である場合、または呼び出し元に十分な特権がない場合に失敗することがあります。

Hosted Network の開始を強制するこの関数は、ユーザーが適切な関連特権を持っている場合にのみ呼び出せます。アクセス許可は、WLAN_SECURABLE_OBJECT に関連付けられた随意アクセス制御リスト (DACL) に格納されます。 WlanHostedNetworkForceStart を呼び出すには、呼び出し元のクライアントアクセストークンが、WLAN_SECURABLE_OBJECT の次の列挙値で公開される昇格された特権を持っている必要があります。

wlan_secure_hosted_network_elevated_access

ワイヤレス Hosted Network を有効にする機能は、ドメイン内のグループポリシーによって制限される場合もあります。

Windows 7 以降では、Hosted Network に対応したワイヤレスアダプターがマシンに存在する場合、オペレーティングシステムは仮想デバイスをインストールします。コンピューターにワイヤレスネットワークアダプターが 1 つしかない場合、この仮想デバイスは通常、“ネットワーク接続フォルダー” に ‘ワイヤレスネットワーク接続 2’ として、デバイス名 ‘Microsoft Virtual WiFi Miniport adapter’ で表示されます。この仮想デバイスはソフトウェアアクセスポイント (SoftAP) 接続を実行するためだけに使用され、WlanEnumInterfaces 関数が返す一覧には含まれません。この仮想デバイスの有効期間は物理ワイヤレスアダプターに結び付けられています。物理ワイヤレスアダプターが無効にされると、この仮想デバイスも削除されます。この機能は、Wireless LAN Service がインストールされた Windows Server 2008 R2 でも利用できます。

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

各言語での呼び出し定義

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

DWORD WlanHostedNetworkForceStart(
    HANDLE hClientHandle,
    WLAN_HOSTED_NETWORK_REASON* pFailReason,   // optional
    void* pvReserved   // optional
);

[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WlanHostedNetworkForceStart(
    IntPtr hClientHandle,   // HANDLE
    IntPtr pFailReason,   // WLAN_HOSTED_NETWORK_REASON* optional, out
    IntPtr pvReserved   // void* optional
);

<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanHostedNetworkForceStart(
    hClientHandle As IntPtr,   ' HANDLE
    pFailReason As IntPtr,   ' WLAN_HOSTED_NETWORK_REASON* optional, out
    pvReserved As IntPtr   ' void* optional
) As UInteger
End Function

' hClientHandle : HANDLE
' pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out
' pvReserved : void* optional
Declare PtrSafe Function WlanHostedNetworkForceStart Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pFailReason As LongPtr, _
    ByVal pvReserved As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WlanHostedNetworkForceStart = ctypes.windll.wlanapi.WlanHostedNetworkForceStart
WlanHostedNetworkForceStart.restype = wintypes.DWORD
WlanHostedNetworkForceStart.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out
    ctypes.POINTER(None),  # pvReserved : void* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WlanHostedNetworkForceStart = Fiddle::Function.new(
  lib['WlanHostedNetworkForceStart'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out
    Fiddle::TYPE_VOIDP,  # pvReserved : void* optional
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wlanapi")]
extern "system" {
    fn WlanHostedNetworkForceStart(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        pFailReason: *mut i32,  // WLAN_HOSTED_NETWORK_REASON* optional, out
        pvReserved: *mut ()  // void* optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WlanHostedNetworkForceStart(IntPtr hClientHandle, IntPtr pFailReason, IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanHostedNetworkForceStart' -Namespace Win32 -PassThru
# $api::WlanHostedNetworkForceStart(hClientHandle, pFailReason, pvReserved)

#uselib "wlanapi.dll"
#func global WlanHostedNetworkForceStart "WlanHostedNetworkForceStart" sptr, sptr, sptr
; WlanHostedNetworkForceStart hClientHandle, varptr(pFailReason), pvReserved   ; 戻り値は stat
; hClientHandle : HANDLE -> "sptr"
; pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "wlanapi.dll"
#cfunc global WlanHostedNetworkForceStart "WlanHostedNetworkForceStart" sptr, var, sptr
; res = WlanHostedNetworkForceStart(hClientHandle, pFailReason, pvReserved)
; hClientHandle : HANDLE -> "sptr"
; pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out -> "var"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "wlanapi.dll"
#cfunc global WlanHostedNetworkForceStart "WlanHostedNetworkForceStart" sptr, sptr, sptr
; res = WlanHostedNetworkForceStart(hClientHandle, varptr(pFailReason), pvReserved)
; hClientHandle : HANDLE -> "sptr"
; pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。