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