xref: /freebsd/crypto/openssl/doc/man3/ERR_set_mark.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1=pod
2
3=head1 NAME
4
5ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark
6- set mark, clear mark and pop errors until mark
7
8=head1 SYNOPSIS
9
10 #include <openssl/err.h>
11
12 int ERR_set_mark(void);
13 int ERR_pop_to_mark(void);
14 int ERR_clear_last_mark(void);
15
16=head1 DESCRIPTION
17
18ERR_set_mark() sets a mark on the current topmost error record if there
19is one.
20
21ERR_pop_to_mark() will pop the top of the error stack until a mark is found.
22The mark is then removed.  If there is no mark, the whole stack is removed.
23
24ERR_clear_last_mark() removes the last mark added if there is one.
25
26=head1 RETURN VALUES
27
28ERR_set_mark() returns 0 if the error stack is empty, otherwise 1.
29
30ERR_clear_last_mark() and ERR_pop_to_mark() return 0 if there was no mark in the
31error stack, which implies that the stack became empty, otherwise 1.
32
33=head1 COPYRIGHT
34
35Copyright 2003-2021 The OpenSSL Project Authors. All Rights Reserved.
36
37Licensed under the Apache License 2.0 (the "License").  You may not use
38this file except in compliance with the License.  You can obtain a copy
39in the file LICENSE in the source distribution or at
40L<https://www.openssl.org/source/license.html>.
41
42=cut
43