aboutsummaryrefslogtreecommitdiffstats
path: root/api/adapter.h
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2020-11-05 15:25:52 +0100
committerJason A. Donenfeld <Jason@zx2c4.com>2020-11-05 16:58:43 +0100
commit9f3d4667915357b8e7c2dbce87d94e389f8305de (patch)
treef06c600ccc9cff4ce449446f44867580e059c3c2 /api/adapter.h
parentexample: raise to 4MiB (diff)
downloadwintun-9f3d4667915357b8e7c2dbce87d94e389f8305de.tar.xz
wintun-9f3d4667915357b8e7c2dbce87d94e389f8305de.zip
api: remove WintunOpenAdapterDeviceObject
Discourage use of kernel interface, which gives us more flexibility if we ever want to change it. Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'api/adapter.h')
-rw-r--r--api/adapter.h18
1 files changed, 12 insertions, 6 deletions
diff --git a/api/adapter.h b/api/adapter.h
index 3f4532a..f98415a 100644
--- a/api/adapter.h
+++ b/api/adapter.h
@@ -35,12 +35,6 @@ void WINAPI
WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter);
/**
- * @copydoc WINTUN_OPEN_ADAPTER_DEVICE_OBJECT_FUNC
- */
-_Return_type_success_(return != INVALID_HANDLE_VALUE) HANDLE WINAPI
- WintunOpenAdapterDeviceObject(_In_ const WINTUN_ADAPTER *Adapter);
-
-/**
* @copydoc WINTUN_CREATE_ADAPTER_FUNC
*/
_Return_type_success_(return != NULL) WINTUN_ADAPTER *WINAPI WintunCreateAdapter(
@@ -62,3 +56,15 @@ _Return_type_success_(return != FALSE) BOOL WINAPI WintunDeleteAdapter(
*/
_Return_type_success_(return != FALSE) BOOL WINAPI
WintunDeletePoolDriver(_In_z_ const WCHAR *Pool, _Out_opt_ BOOL *RebootRequired);
+
+/**
+ * Returns a handle to the adapter device object.
+ *
+ * @param Adapter Adapter handle obtained with WintunOpenAdapter or WintunCreateAdapter.
+ *
+ * @return If the function succeeds, the return value is adapter device object handle. Must be released with
+ * CloseHandle. If the function fails, the return value is INVALID_HANDLE_VALUE. To get extended error
+ * information, call GetLastError.
+ */
+_Return_type_success_(return != INVALID_HANDLE_VALUE) HANDLE WINAPI
+ AdapterOpenDeviceObject(_In_ const WINTUN_ADAPTER *Adapter); \ No newline at end of file