[Pcsclite-cvs-commit] r2323 - trunk/PCSC/doc

[Ludovic Rousseau]

Author: rousseau
Date: 2007-01-10 09:12:32 +0100 (Wed, 10 Jan 2007)
New Revision: 2323

Modified:
   trunk/PCSC/doc/pcsc-lite.tex
Log:
add SCardIsValidContext() documentation


Modified: trunk/PCSC/doc/pcsc-lite.tex
===================================================================
--- trunk/PCSC/doc/pcsc-lite.tex	2007-01-09 19:55:03 UTC (rev 2322)
+++ trunk/PCSC/doc/pcsc-lite.tex	2007-01-10 08:12:32 UTC (rev 2323)
@@ -76,6 +76,8 @@
 0.9.0 & May 26, 2004 & reformat using \LaTeX{}, correct bugs and add
 parts 4 and 5 \\
 \hline
+0.9.1 & Jan 10, 2007 & add SCardIsValidContext() \\
+\hline
 \end{tabular}
 
 \newpage
@@ -324,6 +326,46 @@
 
 
 %---------%---------%---------%---------%---------%---------
+\subsection{SCardIsValidContext}
+
+\synopsis
+\begin{verbatim}
+#include <winscard.h>
+
+LONG SCardIsValidContext(SCARDCONTEXT hContext);
+\end{verbatim}
+
+\parameters
+
+\begin{tabular}{lll}
+\texttt{hContext} & IN & Connection context to be checked
+\end{tabular}
+
+\desc
+
+This function determines whether a smart card context handle is still
+valid. After a smart card context handle has been set by
+SCardEstablishContext(), it may become not valid if the resource manager
+service has been shut down.
+
+\example
+\begin{verbatim}
+SCARDCONTEXT hContext;
+LONG rv;
+
+rv = SCardEstablishContext(SCARD_SCOPE_SYSTEM, NULL, NULL, &hContext);
+rv = SCardIsValidContext(hContext);
+\end{verbatim}
+
+\returns
+
+\begin{tabular}{ll}
+\texttt{SCARD\_S\_SUCCESS} & Successful\\
+\texttt{SCARD\_E\_INVALID\_HANDLE} & Invalid \texttt{hContext} handle
+\end{tabular}
+
+
+%---------%---------%---------%---------%---------%---------
 \subsection{SCardListReaders}
 
 \synopsis