[Pcsclite-git-commit] [PCSC] 01/02: Doxygen: Improve documentation about SCardCancel()

[Ludovic Rousseau]

This is an automated email from the git hooks/post-receive script.

rousseau pushed a commit to branch master
in repository PCSC.

commit 9311af0419da38e2c10842456694d0c15b78150e
Author: Martin Paljak <martin at martinpaljak.net>
Date:   Wed Mar 29 10:39:58 2017 +0300

    Doxygen: Improve documentation about SCardCancel()
    
    SCardCancel() MUST be called with the same SCARDCONTEXT as
    SCardGetStatusChange().
---
 src/winscard_clnt.c | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/src/winscard_clnt.c b/src/winscard_clnt.c
index 04e5394..c7253b5 100644
--- a/src/winscard_clnt.c
+++ b/src/winscard_clnt.c
@@ -440,7 +440,9 @@ static LONG SCardEstablishContextTH(DWORD, LPCVOID, LPCVOID,
  * @brief Creates an Application Context to the PC/SC Resource Manager.
  *
  * This must be the first WinSCard function called in a PC/SC application.
- * Each thread of an application shall use its own \ref SCARDCONTEXT.
+ * Each thread of an application shall use its own \ref SCARDCONTEXT, unless
+ * calling \ref SCardCancel(), which MUST be called with the same context as the
+ * context used to call \ref SCardGetStatusChange().
  *
  * @ingroup API
  * @param[in] dwScope Scope of the establishment.
@@ -1580,6 +1582,9 @@ end:
  * 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 cancel the ongoing call, use \ref SCardCancel() with the same
+ * \ref SCARDCONTEXT.
+ *
  * @code
  * typedef struct {
  *   LPCSTR szReader;           // Reader name
@@ -3060,8 +3065,8 @@ end:
 }
 
 /**
- * Cancels all pending blocking requests on the SCardGetStatusChange()
- * function.
+ * Cancels all pending blocking requests on the \ref SCardGetStatusChange()
+ * function. MUST be called with the same \ref SCARDCONTEXT as \ref SCardGetStatusChange().
  *
  * @ingroup API
  * @param[in] hContext Connection context to the PC/SC Resource Manager.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pcsclite/PCSC.git