Backwards-compatibility subject to OPENSSL_API_COMPAT
[openssl.git] / doc / crypto / BN_zero.pod
1 =pod
2
3 =head1 NAME
4
5 BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
6 operations
7
8 =head1 SYNOPSIS
9
10  #include <openssl/bn.h>
11
12  void BN_zero(BIGNUM *a);
13  int BN_one(BIGNUM *a);
14
15  const BIGNUM *BN_value_one(void);
16
17  int BN_set_word(BIGNUM *a, unsigned long w);
18  unsigned long BN_get_word(BIGNUM *a);
19
20 Deprecated:
21
22  #if OPENSSL_API_COMPAT < 0x00908000L
23  int BN_zero(BIGNUM *a);
24  #endif
25
26 =head1 DESCRIPTION
27
28 BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
29 B<w> respectively.  BN_zero() and BN_one() are macros.
30
31 BN_value_one() returns a B<BIGNUM> constant of value 1. This constant
32 is useful for use in comparisons and assignment.
33
34 BN_get_word() returns B<a>, if it can be represented as an unsigned
35 long.
36
37 =head1 RETURN VALUES
38
39 BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
40 be represented as an unsigned long.
41
42 BN_one(), BN_set_word() and the deprecated version of BN_zero()
43 return 1 on success, 0 otherwise.
44 BN_value_one() returns the constant.
45 The preferred version of BN_zer() never fails and returns no value.
46
47 =head1 BUGS
48
49 Someone might change the constant.
50
51 If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
52 unsigned long but this value is also returned on error.
53
54 =head1 SEE ALSO
55
56 L<bn(3)>, L<BN_bn2bin(3)>
57
58 =cut