Add a number of documentation files, mostly for SSL routines, but also
[openssl.git] / doc / ssl / SSL_new.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_new - Create a new SSL structure for a connection
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  SSL *SSL_new(SSL_CTX *ctx);
12
13 =head1 DESCRIPTION
14
15 SSL_new() creates a new B<SSL> structure which is needed to hold the data
16 for a SSL connection. The new SSL inherits the settings of the underlying
17 context B<ctx>: connection method (SSLv2/v3/TLSv1), options, verification
18 settings, timeout settings.
19
20 =head1 RETURN VALUES
21
22 The following return values can occur:
23
24 =over 4
25
26 =item NULL
27
28 The creation of a new SSL failed. Check the error stack to find out the
29 reason.
30
31 =item Pointer to an SSL
32
33 The return value points to an allocated SSL structure.
34
35 =back
36
37 =head1 SEE ALSO
38
39 L<SSL_free(3)|SSL_free(3)>, L<SSL_clear(3)|SSL_clear(3)>,
40 L<ssl(3)|ssl(3)>
41
42 =cut