Doxygen: document dwCurrentState use for "\\?PnP?\Notification"

LudovicRousseau · Aug 4, 2024 · 78c0832 · 78c0832
1 parent a2c25c5
commit 78c0832
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/src/winscard_clnt.c b/src/winscard_clnt.c
@@ -1586,9 +1586,13 @@ LONG SCardStatus(SCARDHANDLE hCard, LPSTR szReaderName,
  * be used to detect a card removal/insertion between two calls to
  * SCardGetStatusChange()
  *
- * To wait for a reader event (reader added or removed) you may use the special
- * reader name \c "\\?PnP?\Notification". If a reader event occurs the state of
- * this reader will change and the bit \ref SCARD_STATE_CHANGED will be set.
+ * To wait for a reader event (reader added or removed) you may use the
+ * special reader name \c "\\?PnP?\Notification". If a reader event
+ * occurs the state of this reader will change and the bit \ref
+ * SCARD_STATE_CHANGED will be set.
+ * To detect a reader event betweeen 2 calls to SCardGetStatusChange()
+ * you can use the upper 16 bits of \p dwCurrentState. See https://blog.apdu.fr/posts/2024/08/improved-scardgetstatuschange-for-pnpnotification-special-reader/
+
  *
  * To cancel the ongoing call, use SCardCancel() with the same
  * \ref SCARDCONTEXT.