[Pcsclite-cvs-commit] r3058 - /trunk/PCSC/src/winscard_clnt.c

rousseau at users.alioth.debian.org rousseau at users.alioth.debian.org
Mon Jul 7 08:52:51 UTC 2008


Author: rousseau
Date: Mon Jul  7 08:52:51 2008
New Revision: 3058

URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=3058
Log:
SCardGetStatusChange(): Doxygen document the use of "\\?PnP?\Notification" 

Modified:
    trunk/PCSC/src/winscard_clnt.c

Modified: trunk/PCSC/src/winscard_clnt.c
URL: http://svn.debian.org/wsvn/pcsclite/trunk/PCSC/src/winscard_clnt.c?rev=3058&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_clnt.c (original)
+++ trunk/PCSC/src/winscard_clnt.c Mon Jul  7 08:52:51 2008
@@ -1652,8 +1652,9 @@
  * The new event state will be contained in \p dwEventState. A status change
  * might be a card insertion or removal event, a change in ATR, etc.
  *
- * This function will block for reader availability if \p cReaders is equal to
- * zero and \p rgReaderStates is NULL.
+ * 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.
  *
  * @code
  * typedef struct {
@@ -1718,16 +1719,20 @@
  * @test
  * @code
  * SCARDCONTEXT hContext;
- * SCARD_READERSTATE_A rgReaderStates[1];
+ * SCARD_READERSTATE_A rgReaderStates[2];
  * LONG rv;
  * ...
  * rv = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &hContext);
  * ...
  * rgReaderStates[0].szReader = "Reader X";
  * rgReaderStates[0].dwCurrentState = SCARD_STATE_UNAWARE;
+ *
+ * rgReaderStates[1].szReader = "\\\\?PnP?\\Notification";
+ * rgReaderStates[1].dwCurrentState = SCARD_STATE_UNAWARE;
  * ...
- * rv = SCardGetStatusChange(hContext, INFINITE, rgReaderStates, 1);
+ * rv = SCardGetStatusChange(hContext, INFINITE, rgReaderStates, 2);
  * printf("reader state: 0x%04X\n", rgReaderStates[0].dwEventState);
+ * printf("reader state: 0x%04X\n", rgReaderStates[1].dwEventState);
  * @endcode
  */
 LONG SCardGetStatusChange(SCARDCONTEXT hContext, DWORD dwTimeout,




More information about the Pcsclite-cvs-commit mailing list