diff options
Diffstat (limited to 'static/freebsd/man3/ERR_set_mark.3')
| -rw-r--r-- | static/freebsd/man3/ERR_set_mark.3 | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/static/freebsd/man3/ERR_set_mark.3 b/static/freebsd/man3/ERR_set_mark.3 new file mode 100644 index 00000000..53e79446 --- /dev/null +++ b/static/freebsd/man3/ERR_set_mark.3 @@ -0,0 +1,118 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) +.\" +.\" 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 +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l +.\" ======================================================================== +.\" +.IX Title "ERR_SET_MARK 3ossl" +.TH ERR_SET_MARK 3ossl 2026-04-07 3.5.6 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 +ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark, ERR_count_to_mark, ERR_pop \- +set mark, clear mark, pop errors until mark and pop last error +.SH SYNOPSIS +.IX Header "SYNOPSIS" +.Vb 1 +\& #include <openssl/err.h> +\& +\& int ERR_set_mark(void); +\& int ERR_pop_to_mark(void); +\& int ERR_clear_last_mark(void); +\& int ERR_count_to_mark(void); +\& int ERR_pop(void); +.Ve +.SH DESCRIPTION +.IX Header "DESCRIPTION" +\&\fBERR_set_mark()\fR sets a mark on the current topmost error record if there +is one. +.PP +\&\fBERR_pop_to_mark()\fR will pop the top of the error stack until a mark is found. +The mark is then removed. If there is no mark, the whole stack is removed. +.PP +\&\fBERR_clear_last_mark()\fR removes the last mark added if there is one. +.PP +\&\fBERR_count_to_mark()\fR returns the number of entries on the error stack above the +most recently marked entry, not including that entry. If there is no mark in the +error stack, the number of entries in the error stack is returned. +.PP +\&\fBERR_pop()\fR unconditionally pops a single error entry from the top of the error +stack (which is the entry obtainable via \fBERR_peek_last_error\fR\|(3)). +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fBERR_set_mark()\fR returns 0 if the error stack is empty, otherwise 1. +.PP +\&\fBERR_clear_last_mark()\fR and \fBERR_pop_to_mark()\fR return 0 if there was no mark in the +error stack, which implies that the stack became empty, otherwise 1. +.PP +\&\fBERR_count_to_mark()\fR returns the number of error stack entries found above the +most recent mark, if any, or the total number of error stack entries. +.PP +\&\fBERR_pop()\fR returns 1 if an error was popped or 0 if the error stack was empty. +.SH HISTORY +.IX Header "HISTORY" +\&\fBERR_count_to_mark()\fR was added in OpenSSL 3.2. +\&\fBERR_pop()\fR was added in OpenSSL 3.3. +.SH COPYRIGHT +.IX Header "COPYRIGHT" +Copyright 2003\-2024 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>. |