doc/man3/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 =head1 DESCRIPTION
  21
  22 BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
  23 B<w> respectively.  BN_zero() and BN_one() are macros.
  24
  25 BN_value_one() returns a B<BIGNUM> constant of value 1. This constant
  26 is useful for use in comparisons and assignment.
  27
  28 BN_get_word() returns B<a>, if it can be represented as an unsigned
  29 long.
  30
  31 =head1 RETURN VALUES
  32
  33 BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
  34 be represented as an unsigned long.
  35
  36 BN_one() and BN_set_word() return 1 on success, 0 otherwise.
  37 BN_value_one() returns the constant.
  38 BN_zero() never fails and returns no value.
  39
  40 =head1 BUGS
  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_bn2bin(3)>
  48
  49 =head1 HISTORY
  50
  51 In OpenSSL 0.9.8, BN_zero() was changed to not return a value; previous
  52 versions returned an int.
  53
  54 =head1 COPYRIGHT
  55
  56 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  57
  58 Licensed under the OpenSSL license (the "License").  You may not use
  59 this file except in compliance with the License.  You can obtain a copy
  60 in the file LICENSE in the source distribution or at
  61 L<https://www.openssl.org/source/license.html>.
  62
  63 =cut