Add an OpenSSL library context
[openssl.git] / doc / man3 / OPENSSL_CTX.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_CTX, OPENSSL_CTX_new, OPENSSL_CTX_free - OpenSSL library context
6
7 =head1 SYNOPSIS
8
9  #include <openssl/crypto.h>
10
11  typedef struct openssl_ctx_st OPENSSL_CTX;
12
13  OPENSSL_CTX *OPENSSL_CTX_new(void);
14  void OPENSSL_CTX_free(OPENSSL_CTX *ctx);
15
16 =head1 DESCRIPTION
17
18 C<OPENSSL_CTX> is an internal OpenSSL library context type.
19 Applications may allocate their own, but may also use C<NULL> to use
20 the internal default context with functions that take a C<OPENSSL_CTX>
21 argument.
22
23 OPENSSL_CTX_new() creates a new OpenSSL library context.
24
25 OPENSSL_CTX_free() frees the given C<ctx>.
26
27 =head1 RETURN VALUES
28
29 OPENSSL_CTX_new() return a library context pointer on success, or
30 C<NULL> on error.
31
32 OPENSSL_CTX_free() doesn't return any value.
33
34 =head1 HISTORY
35
36 OPENSSL_CTX, OPENSSL_CTX_new() and OPENSSL_CTX_free()
37 were added in OpenSSL 3.0.0.
38
39 =head1 COPYRIGHT
40
41 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the Apache License 2.0 (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut