xref: /onnv-gate/usr/src/common/openssl/doc/crypto/ERR_set_mark.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948ERR_set_mark, ERR_pop_to_mark - set marks and pop errors until mark
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/err.h>
10*2175Sjp161948
11*2175Sjp161948 int ERR_set_mark(void);
12*2175Sjp161948
13*2175Sjp161948 int ERR_pop_to_mark(void);
14*2175Sjp161948
15*2175Sjp161948=head1 DESCRIPTION
16*2175Sjp161948
17*2175Sjp161948ERR_set_mark() sets a mark on the current topmost error record if there
18*2175Sjp161948is one.
19*2175Sjp161948
20*2175Sjp161948ERR_pop_to_mark() will pop the top of the error stack until a mark is found.
21*2175Sjp161948The mark is then removed.  If there is no mark, the whole stack is removed.
22*2175Sjp161948
23*2175Sjp161948=head1 RETURN VALUES
24*2175Sjp161948
25*2175Sjp161948ERR_set_mark() returns 0 if the error stack is empty, otherwise 1.
26*2175Sjp161948
27*2175Sjp161948ERR_pop_to_mark() returns 0 if there was no mark in the error stack, which
28*2175Sjp161948implies that the stack became empty, otherwise 1.
29*2175Sjp161948
30*2175Sjp161948=head1 SEE ALSO
31*2175Sjp161948
32*2175Sjp161948L<err(3)|err(3)>
33*2175Sjp161948
34*2175Sjp161948=head1 HISTORY
35*2175Sjp161948
36*2175Sjp161948ERR_set_mark() and ERR_pop_to_mark() were added in OpenSSL 0.9.8.
37*2175Sjp161948
38*2175Sjp161948=cut
39