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