ホーム › NetworkManagement.WiFi › WFDStartOpenSession

WFDStartOpenSession

関数

指定デバイスとのWi-Fi Directセッション確立を非同期で開始する。

DLLwlanapi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD WFDStartOpenSession(
    HANDLE hClientHandle,
    BYTE** pDeviceAddress,
    void* pvContext,   // optional
    WFD_OPEN_SESSION_COMPLETE_CALLBACK pfnCallback,
    HANDLE* phSessionHandle
);

パラメーター

名前	型	方向	説明
hClientHandle	HANDLE	in	Wi-Fi Direct サービスへのクライアントハンドル。このハンドルは、事前に WFDOpenHandle 関数を呼び出して取得したものです。
pDeviceAddress	BYTE**	in	対象デバイスの Wi-Fi Direct デバイスアドレスへのポインター。これは対象の Wi-Fi デバイスの MAC アドレスです。
pvContext	void*	inoptional	省略可能なコンテキストポインター。pfnCallback パラメーターで指定したコールバック関数に渡されます。
pfnCallback	WFD_OPEN_SESSION_COMPLETE_CALLBACK	in	WFDStartOpenSession の要求が完了したときに呼び出されるコールバック関数へのポインター。
phSessionHandle	HANDLE*	out	この Wi-Fi Direct セッションのハンドル。

戻り値の型: DWORD

公式ドキュメント

Windows のペアリング機能であらかじめペアリングされた特定の Wi-Fi Direct デバイスへの、オンデマンド接続を開始します。

戻り値

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

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

戻り値	説明
ERROR_INVALID_HANDLE	ハンドルが無効です。このエラーは、hClientHandle パラメーターで指定されたハンドルがハンドルテーブル内に見つからなかった場合に返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、hClientHandle パラメーターが NULL であるか無効な場合に返されます。また、pDeviceAddress パラメーターが NULL の場合、pfnCallback パラメーターが NULL の場合、または phSessionHandle パラメーターが NULL の場合にも返されます。さらに、dwClientVersion パラメーターが WFD_API_VERSION と等しくない場合にも返されます。
ERROR_INVALID_STATE	グループまたはリソースが、要求された操作を実行できる正しい状態にありません。このエラーは、ドメインのグループポリシーによって Wi-Fi Direct サービスが無効化されている場合に返されます。
ERROR_SERVICE_NOT_ACTIVE	サービスが開始されていません。このエラーは、WLAN AutoConfig サービスが実行されていない場合に返されます。
RPC_STATUS	さまざまなエラーコード。

解説(Remarks)

WFDStartOpenSession 関数は、Windows 8 および Windows Server 2012 で新たに追加された機能である Wi-Fi Direct の一部です。Wi-Fi Direct は、Wi-Fi Alliance による Wi-Fi Peer-to-Peer Technical Specification v1.1 の策定に基づいています(Wi-Fi Alliance Published Specifications を参照してください)。Wi-Fi Peer-to-Peer Technical Specification の目的は、接続の設定にワイヤレスアクセスポイント (ワイヤレス AP) を必要とせず、また既存の Wi-Fi アドホック (IBSS) の仕組みも使用せずに、Wi-Fi デバイス間の接続を実現する手段を提供することです。

WFDStartOpenSession 関数は、特定の Wi-Fi Direct デバイスへのオンデマンド接続を開始する非同期操作を開始します。対象の Wi-Fi デバイスは、あらかじめ Windows のペアリング機能でペアリングされている必要があります。非同期操作が完了すると、pfnCallback パラメーターで指定したコールバック関数が呼び出されます。

WFDStartOpenSession 関数の非同期処理が完了する前に、アプリケーションが WFDCloseHandle 関数を呼び出して Wi-Fi Direct サービスのハンドルを閉じようとした場合、WFDCloseHandle 関数は WFDStartOpenSession の呼び出しが完了するまで待機します。

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

各言語での呼び出し定義

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

DWORD WFDStartOpenSession(
    HANDLE hClientHandle,
    BYTE** pDeviceAddress,
    void* pvContext,   // optional
    WFD_OPEN_SESSION_COMPLETE_CALLBACK pfnCallback,
    HANDLE* phSessionHandle
);

[DllImport("wlanapi.dll", ExactSpelling = true)]
static extern uint WFDStartOpenSession(
    IntPtr hClientHandle,   // HANDLE
    IntPtr pDeviceAddress,   // BYTE**
    IntPtr pvContext,   // void* optional
    IntPtr pfnCallback,   // WFD_OPEN_SESSION_COMPLETE_CALLBACK
    IntPtr phSessionHandle   // HANDLE* out
);

<DllImport("wlanapi.dll", ExactSpelling:=True)>
Public Shared Function WFDStartOpenSession(
    hClientHandle As IntPtr,   ' HANDLE
    pDeviceAddress As IntPtr,   ' BYTE**
    pvContext As IntPtr,   ' void* optional
    pfnCallback As IntPtr,   ' WFD_OPEN_SESSION_COMPLETE_CALLBACK
    phSessionHandle As IntPtr   ' HANDLE* out
) As UInteger
End Function

' hClientHandle : HANDLE
' pDeviceAddress : BYTE**
' pvContext : void* optional
' pfnCallback : WFD_OPEN_SESSION_COMPLETE_CALLBACK
' phSessionHandle : HANDLE* out
Declare PtrSafe Function WFDStartOpenSession Lib "wlanapi" ( _
    ByVal hClientHandle As LongPtr, _
    ByVal pDeviceAddress As LongPtr, _
    ByVal pvContext As LongPtr, _
    ByVal pfnCallback As LongPtr, _
    ByVal phSessionHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

WFDStartOpenSession = ctypes.windll.wlanapi.WFDStartOpenSession
WFDStartOpenSession.restype = wintypes.DWORD
WFDStartOpenSession.argtypes = [
    wintypes.HANDLE,  # hClientHandle : HANDLE
    ctypes.c_void_p,  # pDeviceAddress : BYTE**
    ctypes.POINTER(None),  # pvContext : void* optional
    ctypes.c_void_p,  # pfnCallback : WFD_OPEN_SESSION_COMPLETE_CALLBACK
    ctypes.c_void_p,  # phSessionHandle : HANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wlanapi.dll')
WFDStartOpenSession = Fiddle::Function.new(
  lib['WFDStartOpenSession'],
  [
    Fiddle::TYPE_VOIDP,  # hClientHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # pDeviceAddress : BYTE**
    Fiddle::TYPE_VOIDP,  # pvContext : void* optional
    Fiddle::TYPE_VOIDP,  # pfnCallback : WFD_OPEN_SESSION_COMPLETE_CALLBACK
    Fiddle::TYPE_VOIDP,  # phSessionHandle : HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "wlanapi")]
extern "system" {
    fn WFDStartOpenSession(
        hClientHandle: *mut core::ffi::c_void,  // HANDLE
        pDeviceAddress: *mut *mut u8,  // BYTE**
        pvContext: *mut (),  // void* optional
        pfnCallback: *const core::ffi::c_void,  // WFD_OPEN_SESSION_COMPLETE_CALLBACK
        phSessionHandle: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("wlanapi.dll")]
public static extern uint WFDStartOpenSession(IntPtr hClientHandle, IntPtr pDeviceAddress, IntPtr pvContext, IntPtr pfnCallback, IntPtr phSessionHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wlanapi_WFDStartOpenSession' -Namespace Win32 -PassThru
# $api::WFDStartOpenSession(hClientHandle, pDeviceAddress, pvContext, pfnCallback, phSessionHandle)

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

出力引数:

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