reword RI description
[openssl.git] / doc / ssl / SSL_get_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_version - get the protocol version of a connection.
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  const char *SSL_get_version(const SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 SSL_get_cipher_version() returns the name of the protocol used for the
16 connection B<ssl>.
17
18 =head1 RETURN VALUES
19
20 The following strings can occur:
21
22 =over 4
23
24 =item SSLv2
25
26 The connection uses the SSLv2 protocol.
27
28 =item SSLv3
29
30 The connection uses the SSLv3 protocol.
31
32 =item TLSv1
33
34 The connection uses the TLSv1 protocol.
35
36 =item unknown
37
38 This indicates that no version has been set (no connection established).
39
40 =back
41
42 =head1 SEE ALSO
43
44 L<ssl(3)|ssl(3)>
45
46 =cut