xref: /onnv-gate/usr/src/common/openssl/doc/crypto/DSA_new.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948DSA_new, DSA_free - allocate and free DSA objects
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/dsa.h>
10*2175Sjp161948
11*2175Sjp161948 DSA* DSA_new(void);
12*2175Sjp161948
13*2175Sjp161948 void DSA_free(DSA *dsa);
14*2175Sjp161948
15*2175Sjp161948=head1 DESCRIPTION
16*2175Sjp161948
17*2175Sjp161948DSA_new() allocates and initializes a B<DSA> structure. It is equivalent to
18*2175Sjp161948calling DSA_new_method(NULL).
19*2175Sjp161948
20*2175Sjp161948DSA_free() frees the B<DSA> structure and its components. The values are
21*2175Sjp161948erased before the memory is returned to the system.
22*2175Sjp161948
23*2175Sjp161948=head1 RETURN VALUES
24*2175Sjp161948
25*2175Sjp161948If the allocation fails, DSA_new() returns B<NULL> and sets an error
26*2175Sjp161948code that can be obtained by
27*2175Sjp161948L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns a pointer
28*2175Sjp161948to the newly allocated structure.
29*2175Sjp161948
30*2175Sjp161948DSA_free() returns no value.
31*2175Sjp161948
32*2175Sjp161948=head1 SEE ALSO
33*2175Sjp161948
34*2175Sjp161948L<dsa(3)|dsa(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
35*2175Sjp161948L<DSA_generate_parameters(3)|DSA_generate_parameters(3)>,
36*2175Sjp161948L<DSA_generate_key(3)|DSA_generate_key(3)>
37*2175Sjp161948
38*2175Sjp161948=head1 HISTORY
39*2175Sjp161948
40*2175Sjp161948DSA_new() and DSA_free() are available in all versions of SSLeay and OpenSSL.
41*2175Sjp161948
42*2175Sjp161948=cut
43