aboutsummaryrefslogtreecommitdiffstats log msg author committer range
path: root/doc/crypto/BN_zero.pod
blob: b555ec39885999ba61f36e0853d984a89beaa09d (plain) (blame)
 ```1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 ``` ``````=pod =head1 NAME BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment operations =head1 SYNOPSIS #include int BN_zero(BIGNUM *a); int BN_one(BIGNUM *a); const BIGNUM *BN_value_one(void); 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 to the values 0, 1 and B respectively. BN_zero() and BN_one() are macros. BN_value_one() returns a B constant of value 1. This constant is useful for use in comparisons and assignment. BN_get_word() returns B, if it can be represented as an unsigned long. =head1 RETURN VALUES BN_get_word() returns the value B, and 0xffffffffL if B 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. If a B is equal to 0xffffffffL it can be represented as an unsigned long but this value is also returned on error. =head1 SEE ALSO L, L =head1 HISTORY BN_zero(), BN_one() and BN_set_word() are available in all versions of SSLeay and OpenSSL. BN_value_one() and BN_get_word() were added in SSLeay 0.8. BN_value_one() was changed to return a true const BIGNUM * in OpenSSL 0.9.7. =cut ``````