Doc nits cleanup, round 2
[openssl.git] / doc / ssl / SSL_CTX_ctrl.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_ctrl, SSL_CTX_callback_ctrl, SSL_ctrl, SSL_callback_ctrl - internal handling functions for SSL_CTX and SSL objects
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
12  long SSL_CTX_callback_ctrl(SSL_CTX *, int cmd, void (*fp)());
13
14  long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
15  long SSL_callback_ctrl(SSL *, int cmd, void (*fp)());
16
17 =head1 DESCRIPTION
18
19 The SSL_*_ctrl() family of functions is used to manipulate settings of
20 the SSL_CTX and SSL objects. Depending on the command B<cmd> the arguments
21 B<larg>, B<parg>, or B<fp> are evaluated. These functions should never
22 be called directly. All functionalities needed are made available via
23 other functions or macros.
24
25 =head1 RETURN VALUES
26
27 The return values of the SSL*_ctrl() functions depend on the command
28 supplied via the B<cmd> parameter.
29
30 =head1 SEE ALSO
31
32 L<ssl(3)>
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