Import OpenSSL-0.9.8i.
[dragonfly.git] / crypto / openssl-0.9.7d / doc / crypto / DSA_new.pod
blob48e9b82a09c8dbba2ab4225632c9311313ab2627
1 =pod
3 =head1 NAME
5 DSA_new, DSA_free - allocate and free DSA objects
7 =head1 SYNOPSIS
9  #include <openssl/dsa.h>
11  DSA* DSA_new(void);
13  void DSA_free(DSA *dsa);
15 =head1 DESCRIPTION
17 DSA_new() allocates and initializes a B<DSA> structure. It is equivalent to
18 calling DSA_new_method(NULL).
20 DSA_free() frees the B<DSA> structure and its components. The values are
21 erased before the memory is returned to the system.
23 =head1 RETURN VALUES
25 If the allocation fails, DSA_new() returns B<NULL> and sets an error
26 code that can be obtained by
27 L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer
28 to the newly allocated structure.
30 DSA_free() returns no value.
32 =head1 SEE ALSO
34 L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
35 L<DSA_generate_parameters(3)|DSA_generate_parameters(3)>,
36 L<DSA_generate_key(3)|DSA_generate_key(3)>
38 =head1 HISTORY
40 DSA_new() and DSA_free() are available in all versions of SSLeay and OpenSSL.
42 =cut