Debian Codegraph @

upstream/debian-unstable/man3/ERR_set_mark.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 "ERR_SET_MARK 3SSL"
58 .TH ERR_SET_MARK 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 ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark, ERR_count_to_mark, ERR_pop \-
65 set mark, clear mark, pop errors until mark and pop last error
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/err.h>
70 \&
71 \& int ERR_set_mark(void);
72 \& int ERR_pop_to_mark(void);
73 \& int ERR_clear_last_mark(void);
74 \& int ERR_count_to_mark(void);
75 \& int ERR_pop(void);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBERR_set_mark()\fR sets a mark on the current topmost error record if there
80 is one.
81 .PP
82 \&\fBERR_pop_to_mark()\fR will pop the top of the error stack until a mark is found.
83 The mark is then removed. If there is no mark, the whole stack is removed.
84 .PP
85 \&\fBERR_clear_last_mark()\fR removes the last mark added if there is one.
86 .PP
87 \&\fBERR_count_to_mark()\fR returns the number of entries on the error stack above the
88 most recently marked entry, not including that entry. If there is no mark in the
89 error stack, the number of entries in the error stack is returned.
90 .PP
91 \&\fBERR_pop()\fR unconditionally pops a single error entry from the top of the error
92 stack (which is the entry obtainable via \fBERR_peek_last_error\fR\|(3)).
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 \&\fBERR_set_mark()\fR returns 0 if the error stack is empty, otherwise 1.
96 .PP
97 \&\fBERR_clear_last_mark()\fR and \fBERR_pop_to_mark()\fR return 0 if there was no mark in the
98 error stack, which implies that the stack became empty, otherwise 1.
99 .PP
100 \&\fBERR_count_to_mark()\fR returns the number of error stack entries found above the
101 most recent mark, if any, or the total number of error stack entries.
102 .PP
103 \&\fBERR_pop()\fR returns 1 if an error was popped or 0 if the error stack was empty.
104 .SH HISTORY
105 .IX Header "HISTORY"
106 \&\fBERR_count_to_mark()\fR was added in OpenSSL 3.2.
107 \&\fBERR_pop()\fR was added in OpenSSL 3.3.
108 .SH COPYRIGHT
109 .IX Header "COPYRIGHT"
110 Copyright 2003\-2024 The OpenSSL Project Authors. All Rights Reserved.
111 .PP
112 Licensed under the Apache License 2.0 (the "License"). You may not use
113 this file except in compliance with the License. You can obtain a copy
114 in the file LICENSE in the source distribution or at
115 <https://www.openssl.org/source/license.html>.