[Pcsclite-git-commit] [PCSC] 06/11: Doxygen: fix SCardListReaderGroups() documentation

[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 43bac6981940ae3e8f05122342df6515aacb7fe8
Author: Ludovic Rousseau <ludovic.rousseau at free.fr>
Date:   Fri Mar 11 10:24:59 2016 +0100

    Doxygen: fix SCardListReaderGroups() documentation
    
    The error code SCARD_E_INVALID_PARAMETER is returned if mszGroups is
    NULL _and_ *pcchGroups == SCARD_AUTOALLOCATE.
    
    Having mszGroups == NULL is the normal way to get the string size in the
    pcchGroups parameter.
    
    Thanks to Maksim Ivanov for the bug report
    http://lists.alioth.debian.org/pipermail/pcsclite-muscle/Week-of-Mon-20160307/000536.html
---
 src/winscard_clnt.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/winscard_clnt.c b/src/winscard_clnt.c
index 1c208fc..de65d2b 100644
--- a/src/winscard_clnt.c
+++ b/src/winscard_clnt.c
@@ -2919,7 +2919,7 @@ LONG SCardFreeMemory(SCARDCONTEXT hContext, LPCVOID pvMem)
  * @retval SCARD_S_SUCCESS Successful (\ref SCARD_S_SUCCESS)
  * @retval SCARD_E_INSUFFICIENT_BUFFER Reader buffer not large enough (\ref SCARD_E_INSUFFICIENT_BUFFER)
  * @retval SCARD_E_INVALID_HANDLE Invalid Scope Handle (\ref SCARD_E_INVALID_HANDLE)
- * @retval SCARD_E_INVALID_PARAMETER \p mszGroups is NULL (\ref SCARD_E_INVALID_PARAMETER)
+ * @retval SCARD_E_INVALID_PARAMETER \p mszGroups is NULL and \p *pcchGroups == \ref SCARD_AUTOALLOCATE (\ref SCARD_E_INVALID_PARAMETER)
  * @retval SCARD_E_NO_MEMORY Memory allocation failed (\ref SCARD_E_NO_MEMORY)
  * @retval SCARD_E_NO_SERVICE The server is not running (\ref SCARD_E_NO_SERVICE)
  *

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