Debian Codegraph @

upstream/debian-unstable/man3/EVP_CIPHER_CTX_get_app_data.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "EVP_CIPHER_CTX_GET_APP_DATA 3SSL"
58 .TH EVP_CIPHER_CTX_GET_APP_DATA 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 EVP_CIPHER_CTX_get_app_data, EVP_CIPHER_CTX_set_app_data \- Routines to
65 inspect and modify application data related to EVP_CIPHER_CTX
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/evp.h>
70 \&
71 \& void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
72 \& void EVP_CIPHER_CTX_set_app_data(EVP_CIPHER_CTX *ctx, void *data);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 The functions \fBEVP_CIPHER_CTX_set_app_data()\fR and \fBEVP_CIPHER_CTX_get_app_data()\fR
77 associate an opaque, application-defined pointer with an EVP_CIPHER_CTX object.
78 .PP
79 This pointer is not interpreted by the library and is reserved entirely for use
80 by the application. It may be used to store arbitrary context or state that
81 needs to be accessible wherever the corresponding EVP_CIPHER_CTX is available.
82 .SH "RETURN VALUES"
83 .IX Header "RETURN VALUES"
84 The \fBEVP_CIPHER_CTX_get_app_data()\fR function returns a opaque pointer to the
85 current application data for the EVP_CIPHER_CTX.
86 .SH COPYRIGHT
87 .IX Header "COPYRIGHT"
88 Copyright 2026 The OpenSSL Project Authors. All Rights Reserved.
89 .PP
90 Licensed under the Apache License 2.0 (the "License"). You may not use
91 this file except in compliance with the License. You can obtain a copy
92 in the file LICENSE in the source distribution or at
93 <https://www.openssl.org/source/license.html>.