Doxygen: SCardEstablishContext() can return SCARD_E_SERVICE_STOPPED

LudovicRousseau · LudovicRousseau · commit c4dbe7b0dd7f · 2025-12-23T11:27:01.000+01:00
This happens when the server and the client do not share the same
communication protocol version.
diff --git a/src/winscard_clnt.c b/src/winscard_clnt.c
@@ -449,6 +449,7 @@ static LONG SCardEstablishContextTH(DWORD, LPCVOID, LPCVOID,
  * @retval SCARD_E_INVALID_VALUE Invalid scope type passed (\ref SCARD_E_INVALID_VALUE )
  * @retval SCARD_E_NO_MEMORY There is no free slot to store \p hContext (\ref SCARD_E_NO_MEMORY)
  * @retval SCARD_E_NO_SERVICE The server is not running (\ref SCARD_E_NO_SERVICE)
+ * @retval SCARD_E_SERVICE_STOPPED Wrong communication protocol version (\ref SCARD_E_SERVICE_STOPPED)
  * @retval SCARD_F_COMM_ERROR An internal communications error has been detected (\ref SCARD_F_COMM_ERROR)
  * @retval SCARD_F_INTERNAL_ERROR An internal consistency check failed (\ref SCARD_F_INTERNAL_ERROR)
  *

Original file line number	Diff line number	Diff line change
`@@ -449,6 +449,7 @@ static LONG SCardEstablishContextTH(DWORD, LPCVOID, LPCVOID,`
`449`	`449`	`* @retval SCARD_E_INVALID_VALUE Invalid scope type passed (\ref SCARD_E_INVALID_VALUE )`
`450`	`450`	`* @retval SCARD_E_NO_MEMORY There is no free slot to store \p hContext (\ref SCARD_E_NO_MEMORY)`
`451`	`451`	`* @retval SCARD_E_NO_SERVICE The server is not running (\ref SCARD_E_NO_SERVICE)`
	`452`	`+ * @retval SCARD_E_SERVICE_STOPPED Wrong communication protocol version (\ref SCARD_E_SERVICE_STOPPED)`
`452`	`453`	`* @retval SCARD_F_COMM_ERROR An internal communications error has been detected (\ref SCARD_F_COMM_ERROR)`
`453`	`454`	`* @retval SCARD_F_INTERNAL_ERROR An internal consistency check failed (\ref SCARD_F_INTERNAL_ERROR)`
`454`	`455`	`*`