api: unify Win32 error type

This makes the code more readable and works around the clang-format.exe
issues with _Return_type_success_ source annotation.

Signed-off-by: Simon Rozman <simon@rozman.si>

3 files changed, 40 insertions, 32 deletions

diff --git a/api/api.h b/api/api.h
index 6b05de2..0e31fd7 100644
--- a/api/api.h
+++ b/api/api.h
@@ -7,6 +7,7 @@
 
 #include <Windows.h>
 
+typedef _Return_type_success_(return == ERROR_SUCCESS) DWORD WINSTATUS;
 extern HINSTANCE ResourceModule;
 
 _Check_return_
@@ -22,10 +23,9 @@ NamespaceInit();
 void
 NamespaceCleanup();
 
-_Return_type_success_(return ==
-                             0) extern DWORD(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
+extern WINSTATUS(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
 
-_Return_type_success_(return == 0) extern DWORD(WINAPI *NciGetConnectionName)(
+extern WINSTATUS(WINAPI *NciGetConnectionName)(
     _In_ LPCGUID Guid,
     _Out_z_bytecap_(InDestNameBytes) LPWSTR Name,
     _In_ DWORD InDestNameBytes,
@@ -52,5 +52,5 @@ typedef struct _WINTUN_ADAPTER
 VOID WINAPI
 WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter);
 
-_Return_type_success_(return == 0) DWORD WINAPI
-    WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter);
+WINSTATUS WINAPI
+WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter);
diff --git a/api/devmgmt.c b/api/devmgmt.c
index eefdb97..bee7c8d 100644
--- a/api/devmgmt.c
+++ b/api/devmgmt.c
@@ -31,7 +31,8 @@ const static GUID ADAPTER_NET_GUID = { 0xcac88484L,
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD GetRegString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
+static WINSTATUS
+GetRegString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
 {
     HANDLE Heap = GetProcessHeap();
 
@@ -94,8 +95,8 @@ static _Return_type_success_(return == 0) DWORD GetRegString(_Inout_ LPWSTR *Buf
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD
-    GetRegMultiString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
+static WINSTATUS
+GetRegMultiString(_Inout_ LPWSTR *Buf, _In_ DWORD Len, _In_ DWORD ValueType)
 {
     HANDLE Heap = GetProcessHeap();
 
@@ -163,8 +164,8 @@ static _Return_type_success_(return == 0) DWORD
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD
-    RegQueryString(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ LPWSTR *Value)
+static WINSTATUS
+RegQueryString(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ LPWSTR *Value)
 {
     HANDLE Heap = GetProcessHeap();
     DWORD Size = 256;
@@ -213,8 +214,8 @@ static _Return_type_success_(return == 0) DWORD
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD
-    RegQueryDWORD(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ DWORD *Value)
+static WINSTATUS
+RegQueryDWORD(_In_ HKEY Key, _In_opt_z_ LPCWSTR Name, _Out_ DWORD *Value)
 {
     DWORD ValueType, Size = sizeof(DWORD);
     DWORD Result = RegQueryValueExW(Key, Name, NULL, &ValueType, (BYTE *)Value, &Size);
@@ -249,7 +250,8 @@ static _Return_type_success_(return == 0) DWORD
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD GetDeviceRegistryProperty(
+static WINSTATUS
+GetDeviceRegistryProperty(
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
     _In_ DWORD Property,
@@ -298,7 +300,8 @@ static _Return_type_success_(return == 0) DWORD GetDeviceRegistryProperty(
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD GetDeviceRegistryString(
+static WINSTATUS
+GetDeviceRegistryString(
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
     _In_ DWORD Property,
@@ -338,7 +341,8 @@ static _Return_type_success_(return == 0) DWORD GetDeviceRegistryString(
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD GetDeviceRegistryMultiString(
+static WINSTATUS
+GetDeviceRegistryMultiString(
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
     _In_ DWORD Property,
@@ -410,8 +414,8 @@ IsOurHardwareID(_In_z_ LPWSTR Hwids)
 /**
  * Returns pool-specific device type name.
  */
-static _Return_type_success_(return == 0) DWORD
-    GetPoolDeviceTypeName(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _Out_ LPWSTR *Name)
+static WINSTATUS
+GetPoolDeviceTypeName(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _Out_ LPWSTR *Name)
 {
     HANDLE Heap = GetProcessHeap();
     int Len = 256;
@@ -433,7 +437,8 @@ static _Return_type_success_(return == 0) DWORD
 /**
  * Checks if SPDRP_DEVICEDESC or SPDRP_FRIENDLYNAME match device type name.
  */
-static _Return_type_success_(return == 0) DWORD IsPoolMember(
+static WINSTATUS
+IsPoolMember(
     _In_z_count_c_(MAX_POOL) LPCWSTR Pool,
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
@@ -489,7 +494,8 @@ cleanupDeviceDesc:
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD GetDriverInfoDetail(
+static WINSTATUS
+GetDriverInfoDetail(
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
     _In_ SP_DRVINFO_DATA_W *DriverData,
@@ -518,8 +524,8 @@ static _Return_type_success_(return == 0) DWORD GetDriverInfoDetail(
 /**
  * Check if the device is using Wintun driver.
  */
-static _Return_type_success_(return == 0) DWORD
-    IsUsingOurDriver(_In_ HDEVINFO DevInfo, _In_ SP_DEVINFO_DATA *DevInfoData, _Out_ BOOL *IsOurDriver)
+static WINSTATUS
+IsUsingOurDriver(_In_ HDEVINFO DevInfo, _In_ SP_DEVINFO_DATA *DevInfoData, _Out_ BOOL *IsOurDriver)
 {
     if (!SetupDiBuildDriverInfoList(DevInfo, DevInfoData, SPDIT_COMPATDRIVER))
         return GetLastError();
@@ -565,7 +571,8 @@ static _Return_type_success_(return == 0) DWORD
  *
  * @return ERROR_SUCCESS on success; Win32 error code otherwise
  */
-static _Return_type_success_(return == 0) DWORD InitAdapterData(
+static WINSTATUS
+InitAdapterData(
     _In_ HDEVINFO DevInfo,
     _In_ SP_DEVINFO_DATA *DevInfoData,
     _In_z_count_c_(MAX_POOL) LPCWSTR Pool,
@@ -642,8 +649,8 @@ WintunFreeAdapter(_In_ WINTUN_ADAPTER *Adapter)
  * ERROR_FILE_NOT_FOUND if adapter with given name is not found;
  * ERROR_ALREADY_EXISTS if adapter is found but not a Wintun-class or not a member of the pool
  */
-_Return_type_success_(return == 0) DWORD WINAPI
-    WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter)
+WINSTATUS WINAPI
+WintunGetAdapter(_In_z_count_c_(MAX_POOL) LPCWSTR Pool, _In_z_ LPCWSTR IfName, _Out_ WINTUN_ADAPTER **Adapter)
 {
     DWORD Result;
     HANDLE Mutex = TakeNameMutex(Pool);
diff --git a/api/nci.c b/api/nci.c
index c479f50..b2eca5c 100644
--- a/api/nci.c
+++ b/api/nci.c
@@ -7,13 +7,13 @@
 
 static HMODULE NciModule;
 
-_Return_type_success_(return == 0) DWORD (WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
+WINSTATUS(WINAPI *NciSetConnectionName)(_In_ LPCGUID Guid, _In_z_ LPCWSTR NewName);
 
-_Return_type_success_(return == 0) DWORD (WINAPI *NciGetConnectionName)(
-    _In_ LPCGUID Guid,
-    _Out_z_bytecap_(InDestNameBytes) LPWSTR Name,
-    _In_ DWORD InDestNameBytes,
-    _Out_opt_ DWORD *OutDestNameBytes);
+WINSTATUS(WINAPI *NciGetConnectionName)
+(_In_ LPCGUID Guid,
+ _Out_z_bytecap_(InDestNameBytes) LPWSTR Name,
+ _In_ DWORD InDestNameBytes,
+ _Out_opt_ DWORD *OutDestNameBytes);
 
 void
 NciInit()
@@ -21,8 +21,9 @@ NciInit()
     NciModule = LoadLibraryW(L"nci.dll");
     if (!NciModule)
         return;
-    NciSetConnectionName = (DWORD (WINAPI *)(LPCGUID, LPCWSTR))GetProcAddress(NciModule, "NciSetConnectionName");
-    NciGetConnectionName = (DWORD (WINAPI *)(LPCGUID, LPWSTR, DWORD, DWORD *))GetProcAddress(NciModule, "NciGetConnectionName");
+    NciSetConnectionName = (DWORD(WINAPI *)(LPCGUID, LPCWSTR))GetProcAddress(NciModule, "NciSetConnectionName");
+    NciGetConnectionName =
+        (DWORD(WINAPI *)(LPCGUID, LPWSTR, DWORD, DWORD *))GetProcAddress(NciModule, "NciGetConnectionName");
 }
 
 void