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

rousseau at users.alioth.debian.org rousseau at users.alioth.debian.org
Wed Jul 30 14:38:09 UTC 2008


Author: rousseau
Date: Wed Jul 30 14:38:09 2008
New Revision: 3076

URL: http://svn.debian.org/wsvn/pcsclite/?sc=1&rev=3076
Log:
Doxygen: document the use of SCARD_AUTOALLOCATE with SCardGetAttrib()

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=3076&op=diff
==============================================================================
--- trunk/PCSC/src/winscard_clnt.c (original)
+++ trunk/PCSC/src/winscard_clnt.c Wed Jul 30 14:38:09 2008
@@ -2453,6 +2453,9 @@
  * @brief This function get an attribute from the IFD Handler (reader driver).
  *
  * The list of possible attributes is available in the file \c reader.h.
+ *
+ * If \c pcbAttrLen is equal to \ref SCARD_AUTOALLOCATE then the function
+ * will allocate itself the needed memory. Use SCardFreeMemory() to release it.
  *
  * @ingroup API
  * @param[in] hCard Connection made from SCardConnect().
@@ -2529,6 +2532,21 @@
  *          SCARD_PROTOCOL_RAW, &hCard, &dwActiveProtocol);
  * rv = SCardGetAttrib(hCard, SCARD_ATTR_ATR_STRING, pbAtr, &dwAtrLen);
  * @endcode
+ *
+ * @code
+ * LONG rv;
+ * SCARDCONTEXT hContext;
+ * SCARDHANDLE hCard;
+ * DWORD dwActiveProtocol;
+ * unsigned char *pbAttr;
+ * DWORD dwAttrLen;
+ * ...
+ * rv = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &hContext);
+ * rv = SCardConnect(hContext, "Reader X", SCARD_SHARE_SHARED,
+ *          SCARD_PROTOCOL_RAW, &hCard, &dwActiveProtocol);
+ * dwAttrLen = SCARD_AUTOALLOCATE;
+ * rv = SCardGetAttrib(hCard, SCARD_ATTR_ATR_STRING, (unsigned char *)&pbAttr, &dwAttrLen);
+ * @endcode
  */
 LONG SCardGetAttrib(SCARDHANDLE hCard, DWORD dwAttrId, LPBYTE pbAttr,
 	LPDWORD pcbAttrLen)




More information about the Pcsclite-cvs-commit mailing list