.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CRYPTO_set_ex_data 3"
.TH CRYPTO_set_ex_data 3 2019-12-20 1.0.2u OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CRYPTO_set_ex_data, CRYPTO_get_ex_data \- internal application specific data functions
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/crypto.h>
\&
\& int CRYPTO_set_ex_data(CRYPTO_EX_DATA *r, int idx, void *arg);
\&
\& void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *r, int idx);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Several OpenSSL structures can have application specific data attached to them.
These functions are used internally by OpenSSL to manipulate application
specific data attached to a specific structure.
.PP
These functions should only be used by applications to manipulate
\&\fBCRYPTO_EX_DATA\fR structures passed to the \fBnew_func()\fR, \fBfree_func()\fR and
\&\fBdup_func()\fR callbacks: as passed to \fBRSA_get_ex_new_index()\fR for example.
.PP
\&\fBCRYPTO_set_ex_data()\fR is used to set application specific data, the data is
supplied in the \fBarg\fR parameter and its precise meaning is up to the
application.
.PP
\&\fBCRYPTO_get_ex_data()\fR is used to retrieve application specific data. The data
is returned to the application, this will be the same value as supplied to
a previous \fBCRYPTO_set_ex_data()\fR call.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBCRYPTO_set_ex_data()\fR returns 1 on success or 0 on failure.
.PP
\&\fBCRYPTO_get_ex_data()\fR returns the application data or 0 on failure. 0 may also
be valid application data but currently it can only fail if given an invalid \fBidx\fR
parameter.
.PP
On failure an error code can be obtained from \fBERR_get_error\fR\|(3).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBRSA_get_ex_new_index\fR\|(3),
\&\fBDSA_get_ex_new_index\fR\|(3),
\&\fBDH_get_ex_new_index\fR\|(3)
.SH HISTORY
.IX Header "HISTORY"
\&\fBCRYPTO_set_ex_data()\fR and \fBCRYPTO_get_ex_data()\fR have been available since SSLeay 0.9.0.