aboutsummaryrefslogtreecommitdiffstats
path: root/api/api.c
diff options
context:
space:
mode:
authorSimon Rozman <simon@rozman.si>2020-07-24 08:29:55 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2020-10-30 16:50:59 +0100
commit640605a8d95e6c14d08cb8bda1cb04a062750c5c (patch)
tree727baf67918ba555b9ecc561ed6e9c584fc8d79c /api/api.c
parentapi: simplify workflow (diff)
downloadwintun-640605a8d95e6c14d08cb8bda1cb04a062750c5c.tar.xz
wintun-640605a8d95e6c14d08cb8bda1cb04a062750c5c.zip
api: update documentation
Signed-off-by: Simon Rozman <simon@rozman.si>
Diffstat (limited to 'api/api.c')
-rw-r--r--api/api.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/api/api.c b/api/api.c
index e9e3231..5816b4c 100644
--- a/api/api.c
+++ b/api/api.c
@@ -9,6 +9,16 @@ HINSTANCE ResourceModule;
/**
* Returns the version of the Wintun driver and NDIS system currently loaded.
+ *
+ * @param DriverVersionMaj Pointer to a DWORD to receive the Wintun driver major version number.
+ *
+ * @param DriverVersionMin Pointer to a DWORD to receive the Wintun driver minor version number.
+ *
+ * @param NdisVersionMaj Pointer to a DWORD to receive the NDIS major version number.
+ *
+ * @param NdisVersionMin Pointer to a DWORD to receive the NDIS minor version number.
+ *
+ * @return ERROR_SUCCESS on success; Win32 error code otherwise.
*/
WINTUN_STATUS WINAPI
WintunGetVersion(