lib/libcrypto/man/ERR_set_mark.3

   1 .\"     $OpenBSD: ERR_set_mark.3,v 1.3 2016/11/23 17:59:29 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Richard Levitte <levitte@openssl.org>.
   5 .\" Copyright (c) 2003 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: November 23 2016 $
  52 .Dt ERR_SET_MARK 3
  53 .Os
  54 .Sh NAME
  55 .Nm ERR_set_mark ,
  56 .Nm ERR_pop_to_mark
  57 .Nd set marks and pop OpenSSL errors until mark
  58 .Sh SYNOPSIS
  59 .In openssl/err.h
  60 .Ft int
  61 .Fn ERR_set_mark void
  62 .Ft int
  63 .Fn ERR_pop_to_mark void
  64 .Sh DESCRIPTION
  65 .Fn ERR_set_mark
  66 sets a mark on the current topmost error record if there is one.
  67 .Pp
  68 .Fn ERR_pop_to_mark
  69 will pop the top of the error stack until a mark is found.
  70 The mark is then removed.
  71 If there is no mark, the whole stack is removed.
  72 .Sh RETURN VALUES
  73 .Fn ERR_set_mark
  74 returns 0 if the error stack is empty, otherwise 1.
  75 .Pp
  76 .Fn ERR_pop_to_mark
  77 returns 0 if there was no mark in the error stack, which implies that
  78 the stack became empty, otherwise 1.
  79 .Sh SEE ALSO
  80 .Xr ERR 3
  81 .Sh HISTORY
  82 .Fn ERR_set_mark
  83 and
  84 .Fn ERR_pop_to_mark
  85 were added in OpenSSL 0.9.8.