$NetBSD: BN_CTX_start.3,v 1.25 2024/09/08 13:08:16 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "BN_CTX_start 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BN_CTX_start, BN_CTX_get, BN_CTX_end - use temporary BIGNUM variables Header "SYNOPSIS" .Vb 1 #include <openssl/bn.h> \& void BN_CTX_start(BN_CTX *ctx); \& BIGNUM *BN_CTX_get(BN_CTX *ctx); \& void BN_CTX_end(BN_CTX *ctx); .Ve Header "DESCRIPTION" These functions are used to obtain temporary BIGNUM variables from a BN_CTX (which can been created by using BN_CTX_new\|(3)) in order to save the overhead of repeatedly creating and freeing BIGNUMs in functions that are called from inside a loop.

A function must call BN_CTX_start() first. Then, BN_CTX_get() may be called repeatedly to obtain temporary BIGNUMs. All BN_CTX_get() calls must be made before calling any other functions that use the \fBctx as an argument.

Finally, BN_CTX_end() must be called before returning from the function. If ctx is NULL, nothing is done. When BN_CTX_end() is called, the BIGNUM pointers obtained from \fBBN_CTX_get() become invalid.

Header "RETURN VALUES" \fBBN_CTX_start() and BN_CTX_end() return no values.

\fBBN_CTX_get() returns a pointer to the BIGNUM, or NULL on error. Once BN_CTX_get() has failed, the subsequent calls will return NULL as well, so it is sufficient to check the return value of the last \fBBN_CTX_get() call. In case of an error, an error code is set, which can be obtained by ERR_get_error\|(3).

Header "SEE ALSO" \fBBN_CTX_new\|(3) Header "COPYRIGHT" Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.