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