2
0

CRYPTO_set_ex_data.pod 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. =pod
  2. =head1 NAME
  3. CRYPTO_set_ex_data, CRYPTO_get_ex_data - internal application specific data functions
  4. =head1 SYNOPSIS
  5. #include <openssl/crypto.h>
  6. int CRYPTO_set_ex_data(CRYPTO_EX_DATA *r, int idx, void *arg);
  7. void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *r, int idx);
  8. =head1 DESCRIPTION
  9. Several OpenSSL structures can have application specific data attached to them.
  10. These functions are used internally by OpenSSL to manipulate application
  11. specific data attached to a specific structure.
  12. These functions should only be used by applications to manipulate
  13. B<CRYPTO_EX_DATA> structures passed to the B<new_func()>, B<free_func()> and
  14. B<dup_func()> callbacks: as passed to B<RSA_get_ex_new_index()> for example.
  15. B<CRYPTO_set_ex_data()> is used to set application specific data, the data is
  16. supplied in the B<arg> parameter and its precise meaning is up to the
  17. application.
  18. B<CRYPTO_get_ex_data()> is used to retrieve application specific data. The data
  19. is returned to the application, this will be the same value as supplied to
  20. a previous B<CRYPTO_set_ex_data()> call.
  21. =head1 RETURN VALUES
  22. B<CRYPTO_set_ex_data()> returns 1 on success or 0 on failure.
  23. B<CRYPTO_get_ex_data()> returns the application data or 0 on failure. 0 may also
  24. be valid application data but currently it can only fail if given an invalid B<idx>
  25. parameter.
  26. On failure an error code can be obtained from L<ERR_get_error(3)|ERR_get_error(3)>.
  27. =head1 SEE ALSO
  28. L<RSA_get_ex_new_index(3)|RSA_get_ex_new_index(3)>,
  29. L<DSA_get_ex_new_index(3)|DSA_get_ex_new_index(3)>,
  30. L<DH_get_ex_new_index(3)|DH_get_ex_new_index(3)>
  31. =head1 HISTORY
  32. CRYPTO_set_ex_data() and CRYPTO_get_ex_data() have been available since SSLeay 0.9.0.
  33. =cut