BN_zero.pod 1.1 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4
=pod

=head1 NAME

5 6
BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
operations
U
Ulf Möller 已提交
7 8 9 10 11 12 13 14

=head1 SYNOPSIS

 #include <openssl/bn.h>

 int BN_zero(BIGNUM *a);
 int BN_one(BIGNUM *a);

B
Bodo Möller 已提交
15
 const BIGNUM *BN_value_one(void);
U
Ulf Möller 已提交
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

 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.

D
Dr. Stephen Henson 已提交
43 44 45
If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
unsigned long but this value is also returned on error.

U
Ulf Möller 已提交
46 47
=head1 SEE ALSO

R
Rich Salz 已提交
48
L<bn(3)>, L<BN_bn2bin(3)>
U
Ulf Möller 已提交
49 50

=cut