SSL_CONF_cmd_argv.pod 1.3 KB

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