get_version_number documentation: explicitly mention VERSION_UNKNOWN

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2022-02-12 00:45:21 +01:00
parent 860429f8af
commit d44e050339

View File

@ -4088,6 +4088,10 @@ const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
* \brief Return the (D)TLS protocol version negotiated in the
* given connection.
*
* \note If you call this function too early during the initial
* handshake, before the two sides have agreed on a version,
* this function returns #MBEDTLS_SSL_VERSION_UNKNOWN.
*
* \param ssl The SSL context to query.
* \return The negotiated protocol version.
*/