From 4a7d0f3a9a473816ebcb9efd52d7eda7900de15c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Benjamin=20H=C3=B6glinger-Stelzer?= <nefarius@dhmx.at>
Date: Mon, 21 Sep 2020 17:11:43 +0200
Subject: [PATCH] Added compatibility notes

---
 sdk/src/ViGEmClient.cpp | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/sdk/src/ViGEmClient.cpp b/sdk/src/ViGEmClient.cpp
index 121f287..ec8fcbc 100644
--- a/sdk/src/ViGEmClient.cpp
+++ b/sdk/src/ViGEmClient.cpp
@@ -1017,6 +1017,13 @@ VIGEM_ERROR vigem_target_ds4_update_ex(PVIGEM_CLIENT vigem, PVIGEM_TARGET target
 			return VIGEM_ERROR_INVALID_TARGET;
 		}
 
+		/*
+		 * NOTE: this will not happen on v1.16 due to NTSTATUS accidentally been set
+		 * as STATUS_SUCCESS when the submitted buffer size wasn't the expected one.
+		 * For backwards compatibility this function will silently fail (not cause
+		 * report updates) when run with the v1.16 driver. This API was introduced 
+		 * with v1.17 so it won't affect existing applications built before.
+		 */
 		if (GetLastError() == ERROR_INVALID_PARAMETER)
 		{
 			CloseHandle(lOverlapped.hEvent);