Deprecate the low level DSA functions.
[openssl.git] / doc / man3 / 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 If B<dsa> is NULL nothing is done.
23
24 =head1 RETURN VALUES
25
26 If the allocation fails, DSA_new() returns B<NULL> and sets an error
27 code that can be obtained by
28 L<ERR_get_error(3)>. Otherwise it returns a pointer
29 to the newly allocated structure.
30
31 DSA_free() returns no value.
32
33 =head1 SEE ALSO
34
35 L<DSA_new(3)>, L<ERR_get_error(3)>,
36 L<DSA_generate_parameters(3)>,
37 L<DSA_generate_key(3)>
38
39 =head1 COPYRIGHT
40
41 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
42
43 Licensed under the Apache License 2.0 (the "License").  You may not use
44 this file except in compliance with the License.  You can obtain a copy
45 in the file LICENSE in the source distribution or at
46 L<https://www.openssl.org/source/license.html>.
47
48 =cut