a528d4f0a9
If something was "present in all versions" of SSLeay, or if it was added to a version of SSLeay (and therefore predates OpenSSL), remove mention of it. Documentation history now starts with OpenSSL. Remove mention of all history before OpenSSL 0.9.8, inclusive. Remove all AUTHOR sections. Reviewed-by: Tim Hudson <tjh@openssl.org>
50 lines
1.1 KiB
Text
50 lines
1.1 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
|
|
operations
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/bn.h>
|
|
|
|
int BN_zero(BIGNUM *a);
|
|
int BN_one(BIGNUM *a);
|
|
|
|
const BIGNUM *BN_value_one(void);
|
|
|
|
int BN_set_word(BIGNUM *a, unsigned long w);
|
|
unsigned long BN_get_word(BIGNUM *a);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
|
|
B<w> respectively. BN_zero() and BN_one() are macros.
|
|
|
|
BN_value_one() returns a B<BIGNUM> constant of value 1. This constant
|
|
is useful for use in comparisons and assignment.
|
|
|
|
BN_get_word() returns B<a>, if it can be represented as an unsigned
|
|
long.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
|
|
be represented as an unsigned long.
|
|
|
|
BN_zero(), BN_one() and BN_set_word() return 1 on success, 0 otherwise.
|
|
BN_value_one() returns the constant.
|
|
|
|
=head1 BUGS
|
|
|
|
Someone might change the constant.
|
|
|
|
If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
|
|
unsigned long but this value is also returned on error.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<bn(3)>, L<BN_bn2bin(3)>
|
|
|
|
=cut
|