diff options
Diffstat (limited to 'upstream/debian-unstable/man3/OSSL_ITEM.3ssl')
| -rw-r--r-- | upstream/debian-unstable/man3/OSSL_ITEM.3ssl | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/OSSL_ITEM.3ssl b/upstream/debian-unstable/man3/OSSL_ITEM.3ssl new file mode 100644 index 00000000..382db297 --- /dev/null +++ b/upstream/debian-unstable/man3/OSSL_ITEM.3ssl @@ -0,0 +1,100 @@ +.\" -*- 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 "OSSL_ITEM 3SSL" +.TH OSSL_ITEM 3SSL 2024-02-03 3.1.5 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 +OSSL_ITEM \- OpenSSL Core type for generic itemized data +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/core.h> +\& +\& typedef struct ossl_item_st OSSL_ITEM; +\& struct ossl_item_st { +\& unsigned int id; +\& void *ptr; +\& }; +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +This type is a tuple of integer and pointer. +It's a generic type used as a generic descriptor, its exact meaning +being defined by how it's used. +Arrays of this type are passed between the OpenSSL libraries and the +providers, and must be terminated with a tuple where the integer is +zero and the pointer NULL. +.PP +This is currently mainly used for the return value of the provider's error +reason strings array, see "Provider Functions" in \fBprovider\-base\fR\|(7). +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fBcrypto\fR\|(7), \fBprovider\-base\fR\|(7), \fBopenssl\-core.h\fR\|(7) +.SH HISTORY +.IX Header "HISTORY" +\&\fBOSSL_ITEM\fR was added in OpenSSL 3.0 +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2022 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +<https://www.openssl.org/source/license.html>. |