Index for Section 3

Alphabetical listing for B

Bottom of page

BN_zero(3)
NAME
  BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
  operations

SYNOPSIS
  #include <openssl/bn.h>

  int BN_zero(
	  BIGNUM *a );

  int BN_one(
	  BIGNUM *a );

  BIGNUM *BN_value_one(
	  void );

  int BN_set_word(
	  BIGNUM *a, unsigned long w );

  unsigned long BN_get_word(
	  BIGNUM *a );

DESCRIPTION
  The BN_zero(), BN_one(), and BN_set_word() functions set a to the values 0,
  1 and w respectively.	 BN_zero() and BN_one() are macros.

  The BN_value_one() function returns a BIGNUM constant of value 1. This
  constant is useful for use in comparisons and assignment.

  The BN_get_word() function returns a, if it can be represented as an
  unsigned long.

RETURN VALUES
  The BN_get_word() function returns the value a, and 0xffffffffL if a cannot
  be represented as an unsigned long.

  The BN_zero(), BN_one(), and BN_set_word() functions return 1 on success, 0
  otherwise. The BN_value_one() function returns the constant.

RESTRICTIONS
  Someone might change the constant.

  If a BIGNUM is equal to 0xffffffffL it can be represented as an unsigned
  long but this value is also returned on error.

HISTORY
  The BN_zero(), BN_one(), and BN_set_word() functions are available in all
  versions of SSLeay and OpenSSL. The BN_value_one() and BN_get_word()
  functions were added in SSLeay 0.8.

SEE ALSO
  Functions: bn(3), BN_bn2bin(3)

Index for Section 3

Alphabetical listing for B

Top of page