xref: /freebsd/crypto/openssl/doc/man3/SSL_CONF_cmd_argv.pod (revision 4c1a82cea504df7a79f5bd8f7d0a41cacccff16e)
1=pod
2
3=head1 NAME
4
5SSL_CONF_cmd_argv - SSL configuration command line processing
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 int SSL_CONF_cmd_argv(SSL_CONF_CTX *cctx, int *pargc, char ***pargv);
12
13=head1 DESCRIPTION
14
15The function SSL_CONF_cmd_argv() processes at most two command line
16arguments from B<pargv> and B<pargc>. The values of B<pargv> and B<pargc>
17are updated to reflect the number of command options processed. The B<pargc>
18argument can be set to B<NULL> if it is not used.
19
20=head1 RETURN VALUES
21
22SSL_CONF_cmd_argv() returns the number of command arguments processed: 0, 1, 2
23or a negative error code.
24
25If -2 is returned then an argument for a command is missing.
26
27If -1 is returned the command is recognised but couldn't be processed due
28to an error: for example a syntax error in the argument.
29
30=head1 SEE ALSO
31
32L<SSL_CONF_CTX_new(3)>,
33L<SSL_CONF_CTX_set_flags(3)>,
34L<SSL_CONF_CTX_set1_prefix(3)>,
35L<SSL_CONF_CTX_set_ssl_ctx(3)>,
36L<SSL_CONF_cmd(3)>
37
38=head1 HISTORY
39
40These functions were added in OpenSSL 1.0.2.
41
42=head1 COPYRIGHT
43
44Copyright 2012-2016 The OpenSSL Project Authors. All Rights Reserved.
45
46Licensed under the OpenSSL license (the "License").  You may not use
47this file except in compliance with the License.  You can obtain a copy
48in the file LICENSE in the source distribution or at
49L<https://www.openssl.org/source/license.html>.
50
51=cut
52