Add requested HISTORY section, remove copy/pastos, per review feedback.
[openssl.git] / doc / ssl / SSL_SESSION_get_protocol_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_get_protocol_version - retrieve session protocol version
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_SESSION_get_protocol_version(const SSL_SESSION *s);
12
13 =head1 DESCRIPTION
14
15 SSL_SESSION_get_protocol_version() returns the protocol version number used
16 by session B<s>.
17
18 =head1 RETURN VALUES
19
20 SSL_SESSION_get_protocol_version() returns a number indicating the protocol
21 version used for the session; this number matches the constants I<e.g.>
22 B<TLS1_VERSION> or B<TLS1_2_VERSION>.
23
24 If the function is passed the NULL pointer for the session B<s>, 0 is returned.
25
26 =head1 SEE ALSO
27
28 L<ssl(3)>
29
30 =head1 HISTORY
31
32 SSL_SESSION_get_protocol_version() was first added to OpenSSL 1.1.0
33
34 =head1 COPYRIGHT
35
36 Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved.
37
38 Licensed under the OpenSSL license (the "License").  You may not use
39 this file except in compliance with the License.  You can obtain a copy
40 in the file LICENSE in the source distribution or at
41 L<https://www.openssl.org/source/license.html>.
42
43 =cut