summaryrefslogtreecommitdiffstats
path: root/doc/man3/ERR_set_mark.pod
diff options
context:
space:
mode:
authorHugo Landau <hlandau@openssl.org>2023-08-03 11:56:12 +0100
committerMatt Caswell <matt@openssl.org>2023-08-08 14:33:42 +0100
commit7a2bb2101be4f4dfd9f437ebe1d7fd5dbc14b894 (patch)
tree408accb61c481fc060859267a7d1da3d80c9f3f2 /doc/man3/ERR_set_mark.pod
parent828c9c6690dc2791cee7873cf6793db187b558bb (diff)
QUIC TLS: Rethink error handling
Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21547)
Diffstat (limited to 'doc/man3/ERR_set_mark.pod')
-rw-r--r--doc/man3/ERR_set_mark.pod12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/man3/ERR_set_mark.pod b/doc/man3/ERR_set_mark.pod
index e61d5c61ed..add9b232c0 100644
--- a/doc/man3/ERR_set_mark.pod
+++ b/doc/man3/ERR_set_mark.pod
@@ -2,8 +2,8 @@
=head1 NAME
-ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark
-- set mark, clear mark and pop errors until mark
+ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark, ERR_count_to_mark - set
+mark, clear mark and pop errors until mark
=head1 SYNOPSIS
@@ -12,6 +12,7 @@ ERR_set_mark, ERR_clear_last_mark, ERR_pop_to_mark
int ERR_set_mark(void);
int ERR_pop_to_mark(void);
int ERR_clear_last_mark(void);
+ int ERR_count_to_mark(void);
=head1 DESCRIPTION
@@ -23,6 +24,10 @@ The mark is then removed. If there is no mark, the whole stack is removed.
ERR_clear_last_mark() removes the last mark added if there is one.
+ERR_count_to_mark() returns the number of entries on the error stack above the
+most recently marked entry, not including that entry. If there is no mark in the
+error stack, the number of entries in the error stack is returned.
+
=head1 RETURN VALUES
ERR_set_mark() returns 0 if the error stack is empty, otherwise 1.
@@ -30,6 +35,9 @@ ERR_set_mark() returns 0 if the error stack is empty, otherwise 1.
ERR_clear_last_mark() and ERR_pop_to_mark() return 0 if there was no mark in the
error stack, which implies that the stack became empty, otherwise 1.
+ERR_count_to_mark() returns the number of error stack entries found above the
+most recent mark, if any, or the total number of error stack entries.
+
=head1 COPYRIGHT
Copyright 2003-2021 The OpenSSL Project Authors. All Rights Reserved.