WFDCloseSession function (wlanapi.h)
The WFDCloseSession function closes a session after a previously successful call to the WFDStartOpenSession function.
Syntax
DWORD WFDCloseSession(
[in] HANDLE hSessionHandle
);
Parameters
[in] hSessionHandle
A session handle to a Wi-Fi Direct session. This is a session handle previously returned by the WFDStartOpenSession function.
Return value
If the function succeeds, the return value is ERROR_SUCCESS.
If the function fails, the return value may be one of the following return codes.
| Return code | Description |
|---|---|
|
The handle is invalid.
This error is returned if the handle specified in the hSessionHandle parameter was not found in the handle table. |
|
The parameter is incorrect.
This error is returned if the hSessionHandle parameter is NULL or not valid. |
|
The group or resource is not in the correct state to perform the requested operation.
This error is returned if the Wi-Fi Direct service is disabled by group policy on a domain. |
|
Various error codes. |
Remarks
The WFDCloseSession function is part of Wi-Fi Direct, a new feature in Windows 8 and Windows Server 2012. Wi-Fi Direct is based on the development of the Wi-Fi Peer-to-Peer Technical Specification v1.1 by the Wi-Fi Alliance (see Wi-Fi Alliance Published Specifications). The goal of the Wi-Fi Peer-to-Peer Technical Specification is to provide a solution for Wi-Fi device-to-device connectivity without the need for either a Wireless Access Point (wireless AP) to setup the connection or the use of the existing Wi-Fi adhoc (IBSS) mechanism.
The WFDCloseSession function queues a future work item to close the session, so disconnection may not be immediate.
Calling the WFDCloseSession function while a WFDStartOpenSession call is pending will not close the session.
It is the responsibility of the caller to pass the WFDCloseSession function a handle in the hSessionHandle parameter that was returned from a successful asynchronous call to the WFDStartOpenSession function.
Calling the WFDCloseSession function with a handle that was valid and has become invalid will yield undefined results.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | wlanapi.h |
| Library | Wlanapi.lib |
| DLL | Wlanapi.dll |