BIO_get_ex_new_index.pod 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. =pod
  2. =head1 NAME
  3. BIO_get_ex_new_index, BIO_set_ex_data, BIO_get_ex_data,
  4. ENGINE_get_ex_new_index, ENGINE_set_ex_data, ENGINE_get_ex_data,
  5. UI_get_ex_new_index, UI_set_ex_data, UI_get_ex_data,
  6. X509_get_ex_new_index, X509_set_ex_data, X509_get_ex_data,
  7. X509_STORE_get_ex_new_index, X509_STORE_set_ex_data, X509_STORE_get_ex_data,
  8. X509_STORE_CTX_get_ex_new_index, X509_STORE_CTX_set_ex_data, X509_STORE_CTX_get_ex_data,
  9. DH_get_ex_new_index, DH_set_ex_data, DH_get_ex_data,
  10. DSA_get_ex_new_index, DSA_set_ex_data, DSA_get_ex_data,
  11. ECDH_get_ex_new_index, ECDH_set_ex_data, ECDH_get_ex_data,
  12. EC_KEY_get_ex_new_index, EC_KEY_set_ex_data, EC_KEY_get_ex_data,
  13. RSA_get_ex_new_index, RSA_set_ex_data, RSA_get_ex_data
  14. - application-specific data
  15. =head1 SYNOPSIS
  16. =for comment generic
  17. #include <openssl/x509.h>
  18. int TYPE_get_ex_new_index(long argl, void *argp,
  19. CRYPTO_EX_new *new_func,
  20. CRYPTO_EX_dup *dup_func,
  21. CRYPTO_EX_free *free_func);
  22. int TYPE_set_ex_data(TYPE *d, int idx, void *arg);
  23. void *TYPE_get_ex_data(TYPE *d, int idx);
  24. =head1 DESCRIPTION
  25. In the description here, I<TYPE> is used a placeholder
  26. for any of the OpenSSL datatypes listed in
  27. L<CRYPTO_get_ex_new_index(3)>.
  28. These functions handle application-specific data for OpenSSL data
  29. structures.
  30. TYPE_get_new_ex_index() is a macro that calls CRYPTO_get_ex_new_index()
  31. with the correct B<index> value.
  32. TYPE_set_ex_data() is a function that calls CRYPTO_set_ex_data() with
  33. an offset into the opaque exdata part of the TYPE object.
  34. TYPE_get_ex_data() is a function that calls CRYPTO_get_ex_data() with
  35. an offset into the opaque exdata part of the TYPE object.
  36. =head1 RETURN VALUES
  37. TYPE_get_new_ex_index() returns a new index on success or -1 on error.
  38. TYPE_set_ex_data() returns 1 on success or 0 on error.
  39. TYPE_get_ex_data() returns the application data or NULL if an error occurred.
  40. =head1 SEE ALSO
  41. L<CRYPTO_get_ex_new_index(3)>.
  42. =head1 COPYRIGHT
  43. Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
  44. Licensed under the Apache License 2.0 (the "License"). You may not use
  45. this file except in compliance with the License. You can obtain a copy
  46. in the file LICENSE in the source distribution or at
  47. L<https://www.openssl.org/source/license.html>.
  48. =cut