Refactoring BIO: add wrappers around sockaddr et al
[openssl.git] / doc / crypto / BN_CTX_start.pod
index 3e1032375f44f651899e7a29f226b7ceea659263..2e23be27a7af2aa1d065aea9f330544b181aee4c 100644 (file)
@@ -17,7 +17,8 @@ BN_CTX_start, BN_CTX_get, BN_CTX_end - use temporary BIGNUM variables
 =head1 DESCRIPTION
 
 These functions are used to obtain temporary B<BIGNUM> variables from
-a B<BN_CTX> in order to save the overhead of repeatedly creating and
+a B<BN_CTX> (which can been created by using L<BN_CTX_new(3)>)
+in order to save the overhead of repeatedly creating and
 freeing B<BIGNUM>s in functions that are called from inside a loop.
 
 A function must call BN_CTX_start() first. Then, BN_CTX_get() may be
@@ -36,14 +37,12 @@ BN_CTX_start() and BN_CTX_end() return no values.
 BN_CTX_get() returns a pointer to the B<BIGNUM>, or B<NULL> on error.
 Once BN_CTX_get() has failed, the subsequent calls will return B<NULL>
 as well, so it is sufficient to check the return value of the last
-BN_CTX_get() call.
+BN_CTX_get() call. In case of an error, an error code is set, which
+can be obtained by L<ERR_get_error(3)>.
 
-=head1 SEE ALSO
-
-L<BN_CTX_new(3)|BN_CTX_new(3)>
 
-=head1 HISTORY
+=head1 SEE ALSO
 
-BN_CTX_start(), BN_CTX_get() and BN_CTX_end() were added in OpenSSL 0.9.5.
+L<BN_CTX_new(3)>
 
 =cut