Provide documentation for i2d_ECPrivateKey and d2i_ECPrivateKey
[openssl.git] / doc / crypto / DSA_new.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_new, DSA_free - allocate and free DSA objects
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dsa.h>
10
11  DSA* DSA_new(void);
12
13  void DSA_free(DSA *dsa);
14
15 =head1 DESCRIPTION
16
17 DSA_new() allocates and initializes a B<DSA> structure. It is equivalent to
18 calling DSA_new_method(NULL).
19
20 DSA_free() frees the B<DSA> structure and its components. The values are
21 erased before the memory is returned to the system.
22
23 =head1 RETURN VALUES
24
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.
29
30 DSA_free() returns no value.
31
32 =head1 SEE ALSO
33
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)>
37
38 =head1 HISTORY
39
40 DSA_new() and DSA_free() are available in all versions of SSLeay and OpenSSL.
41
42 =cut