Document correctness of HandlePtr

Dn-Programming-Core-Management · Jul 7, 2023 · 0fa4c33 · 0fa4c33
1 parent 4a20814
commit 0fa4c33
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/Source/utils/handle_ptr.h b/Source/utils/handle_ptr.h
@@ -13,3 +13,5 @@ struct CloseHandleT {
 
 /// HANDLE is void*, so unique_ptr<void, CloseHandleT> is a RAII HANDLE.
 using HandlePtr = std::unique_ptr<void, CloseHandleT>;
+// https://learn.microsoft.com/en-us/windows/win32/api/synchapi/nf-synchapi-createeventa
+// >If the function fails, the return value is NULL.