doc/crypto/BN_zero.pod

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