ホーム › NetworkManagement.WiFi › WlanHostedNetworkStopUsing

WlanHostedNetworkStopUsing

関数

ホストネットワークの使用を停止し参照カウントを減らす。

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

シグネチャ

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

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

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

ワイヤレス Hosted Network を停止します。

戻り値

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

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

リターンコード	説明
ERROR_INVALID_HANDLE	ハンドルが無効です。このエラーは、hClientHandle パラメーターに指定されたハンドルがハンドルテーブルに見つからなかった場合に返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、次のいずれかの条件に該当する場合に返されます。 hClientHandle が NULL である。 pvReserved が NULL ではない。
ERROR_INVALID_STATE	要求された操作を実行できる正しい状態にリソースがありません。これは、ワイヤレス Hosted Network がシャットダウン処理中であった場合に発生することがあります。
ERROR_SERVICE_NOT_ACTIVE	サービスが開始されていません。このエラーは、WLAN AutoConfig Service が実行されていない場合に返されます。
その他	さまざまな RPC エラーやその他のエラーコード。返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用します。

解説(Remarks)

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

アプリケーションは、Hosted Network を停止するために WlanHostedNetworkStopUsing 関数を呼び出します。アプリケーションは、それ以前に成功した WlanHostedNetworkStartUsing 関数の呼び出しと対にするために、WlanHostedNetworkStopUsing 関数を呼び出します。ワイヤレス Hosted Network は、すべてのアプリケーションが WlanHostedNetworkStopUsing 関数を呼び出すか、強制的に停止するために WlanHostedNetworkForceStop 関数が呼び出されるまで、アクティブなままになります。ワイヤレス Hosted Network が停止すると、状態は wlan_hosted_network_idle に切り替わります。外部要因によって Hosted Network の状態が変化した場合(たとえば、ワイヤレスインターフェイスカードのミニポートドライバーが利用できなくなった場合など)にも、この呼び出しは失敗することがあります。

どのユーザーでも、この関数を呼び出して Hosted Network を停止できます。ただし、ワイヤレス Hosted Network を有効にする機能は、ドメインのグループポリシーによって制限される場合があります。

Windows 7 以降では、Hosted Network に対応したワイヤレスアダプターがコンピューターに存在する場合、オペレーティングシステムは仮想デバイスをインストールします。コンピューターにワイヤレスネットワークアダプターが 1 つだけある場合、この仮想デバイスは通常、「ネットワーク接続フォルダー」に、デバイス名が 'Microsoft Virtual WiFi Miniport adapter' の 'ワイヤレスネットワーク接続 2' として表示されます。この仮想デバイスはソフトウェアアクセスポイント (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 WlanHostedNetworkStopUsing(
    HANDLE hClientHandle,
    WLAN_HOSTED_NETWORK_REASON* pFailReason,   // optional
    void* pvReserved   // optional
);

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

<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WlanHostedNetworkStopUsing(
    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 WlanHostedNetworkStopUsing 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

WlanHostedNetworkStopUsing = ctypes.windll.wlanapi.WlanHostedNetworkStopUsing
WlanHostedNetworkStopUsing.restype = wintypes.DWORD
WlanHostedNetworkStopUsing.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')
WlanHostedNetworkStopUsing = Fiddle::Function.new(
  lib['WlanHostedNetworkStopUsing'],
  [
    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 WlanHostedNetworkStopUsing(
        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 WlanHostedNetworkStopUsing(IntPtr hClientHandle, IntPtr pFailReason, IntPtr pvReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WlanHostedNetworkStopUsing' -Namespace Win32 -PassThru
# $api::WlanHostedNetworkStopUsing(hClientHandle, pFailReason, pvReserved)

#uselib "wlanapi.dll"
#func global WlanHostedNetworkStopUsing "WlanHostedNetworkStopUsing" sptr, sptr, sptr
; WlanHostedNetworkStopUsing 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 WlanHostedNetworkStopUsing "WlanHostedNetworkStopUsing" sptr, var, sptr
; res = WlanHostedNetworkStopUsing(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 WlanHostedNetworkStopUsing "WlanHostedNetworkStopUsing" sptr, sptr, sptr
; res = WlanHostedNetworkStopUsing(hClientHandle, varptr(pFailReason), pvReserved)
; hClientHandle : HANDLE -> "sptr"
; pFailReason : WLAN_HOSTED_NETWORK_REASON* optional, out -> "sptr"
; pvReserved : void* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。