Add copyright to manpages
[openssl.git] / doc / crypto / DSA_SIG_new.pod
1 =pod
2
3 =head1 NAME
4
5 DSA_SIG_new, DSA_SIG_free - allocate and free DSA signature objects
6
7 =head1 SYNOPSIS
8
9  #include <openssl/dsa.h>
10
11  DSA_SIG *DSA_SIG_new(void);
12  void DSA_SIG_free(DSA_SIG *a);
13  void DSA_SIG_get0(BIGNUM **pr, BIGNUM **ps, const DSA_SIG *sig);
14
15 =head1 DESCRIPTION
16
17 DSA_SIG_new() allocates and initializes a B<DSA_SIG> structure.
18
19 DSA_SIG_free() frees the B<DSA_SIG> structure and its components. The
20 values are erased before the memory is returned to the system.
21
22 DSA_SIG_get0() returns internal pointers the B<r> and B<s> values contained
23 in B<sig>. The values can then be examined or initialised.
24
25 =head1 RETURN VALUES
26
27 If the allocation fails, DSA_SIG_new() returns B<NULL> and sets an
28 error code that can be obtained by
29 L<ERR_get_error(3)>. Otherwise it returns a pointer
30 to the newly allocated structure.
31
32 DSA_SIG_free() returns no value.
33
34 =head1 SEE ALSO
35
36 L<dsa(3)>, L<ERR_get_error(3)>,
37 L<DSA_do_sign(3)>
38
39 =cut
40
41 =head1 COPYRIGHT
42
43 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
44
45 Licensed under the OpenSSL license (the "License").  You may not use
46 this file except in compliance with the License.  You can obtain a copy
47 in the file LICENSE in the source distribution or at
48 L<https://www.openssl.org/source/license.html>.
49
50 =cut