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

rousseau at users.alioth.debian.org rousseau at users.alioth.debian.org
Wed Jul 30 14:23:05 UTC 2008


Author: rousseau
Date: Wed Jul 30 14:23:05 2008
New Revision: 3074

URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=3074
Log:
Doxygen: document use of SCARD_AUTOALLOCATE for SCardStatus()

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=3074&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_clnt.c (original)
+++ trunk/PCSC/src/winscard_clnt.c Wed Jul 30 14:23:05 2008
@@ -1441,6 +1441,14 @@
  * state, and protocol will be stored in pdwState and \p pdwProtocol
  * respectively.
  *
+ * If \c *pcchReaderLen is equal to \ref SCARD_AUTOALLOCATE then the function
+ * will allocate itself the needed memory for mszReaderName. Use
+ * SCardFreeMemory() to release it.
+ *
+ * If \c *pcbAtrLen is equal to \ref SCARD_AUTOALLOCATE then the function will
+ * allocate itself the needed memory for pbAtr. Use SCardFreeMemory() to
+ * release it.
+ *
  * @ingroup API
  * @param[in] hCard Connection made from SCardConnect().
  * @param mszReaderName [inout] Friendly name of this reader.
@@ -1484,10 +1492,29 @@
  * BYTE pbAtr[MAX_ATR_SIZE];
  * ...
  * rv = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &hContext);
- * rv = SCardConnect(hContext, "Reader X", SCARD_SHARE_SHARED, SCARD_PROTOCOL_T0, &hCard, &dwActiveProtocol);
+ * rv = SCardConnect(hContext, "Reader X", SCARD_SHARE_SHARED,
+ *          SCARD_PROTOCOL_T0, &hCard, &dwActiveProtocol);
  * ...
  * dwAtrLen = sizeof(pbAtr);
  * rv=SCardStatus(hCard, NULL, &dwReaderLen, &dwState, &dwProtocol, pbAtr, &dwAtrLen);
+ * @endcode
+ *
+ * @code
+ * SCARDCONTEXT hContext;
+ * SCARDHANDLE hCard;
+ * DWORD dwActiveProtocol;
+ * DWORD dwState, dwProtocol, dwAtrLen, dwReaderLen;
+ * BYTE *pbAtr = NULL;
+ * char *pcReader = NULL;
+ * ...
+ * rv = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &hContext);
+ * rv = SCardConnect(hContext, "Reader X", SCARD_SHARE_SHARED,
+ *          SCARD_PROTOCOL_T0, &hCard, &dwActiveProtocol);
+ * ...
+ * dwReaderLen = SCARD_AUTOALLOCATE;
+ * dwAtrLen = SCARD_AUTOALLOCATE;
+ * rv = SCardStatus(hCard, (LPSTR)&pcReader, &dwReaderLen, &dwState,
+ *          &dwProtocol, (LPBYTE)&pbAtr, &dwAtrLen);
  * @endcode
  */
 LONG SCardStatus(SCARDHANDLE hCard, LPSTR mszReaderName,




More information about the Pcsclite-cvs-commit mailing list