xref: /onnv-gate/usr/src/common/openssl/doc/crypto/ASN1_OBJECT_new.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948ASN1_OBJECT_new, ASN1_OBJECT_free, - object allocation functions
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 ASN1_OBJECT *ASN1_OBJECT_new(void);
10*2175Sjp161948 void ASN1_OBJECT_free(ASN1_OBJECT *a);
11*2175Sjp161948
12*2175Sjp161948=head1 DESCRIPTION
13*2175Sjp161948
14*2175Sjp161948The ASN1_OBJECT allocation routines, allocate and free an
15*2175Sjp161948ASN1_OBJECT structure, which represents an ASN1 OBJECT IDENTIFIER.
16*2175Sjp161948
17*2175Sjp161948ASN1_OBJECT_new() allocates and initializes a ASN1_OBJECT structure.
18*2175Sjp161948
19*2175Sjp161948ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure B<a>.
20*2175Sjp161948
21*2175Sjp161948=head1 NOTES
22*2175Sjp161948
23*2175Sjp161948Although ASN1_OBJECT_new() allocates a new ASN1_OBJECT structure it
24*2175Sjp161948is almost never used in applications. The ASN1 object utility functions
25*2175Sjp161948such as OBJ_nid2obj() are used instead.
26*2175Sjp161948
27*2175Sjp161948=head1 RETURN VALUES
28*2175Sjp161948
29*2175Sjp161948If the allocation fails, ASN1_OBJECT_new() returns B<NULL> and sets an error
30*2175Sjp161948code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
31*2175Sjp161948Otherwise it returns a pointer to the newly allocated structure.
32*2175Sjp161948
33*2175Sjp161948ASN1_OBJECT_free() returns no value.
34*2175Sjp161948
35*2175Sjp161948=head1 SEE ALSO
36*2175Sjp161948
37*2175Sjp161948L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_ASN1_OBJECT(3)|d2i_ASN1_OBJECT(3)>
38*2175Sjp161948
39*2175Sjp161948=head1 HISTORY
40*2175Sjp161948
41*2175Sjp161948ASN1_OBJECT_new() and ASN1_OBJECT_free() are available in all versions of SSLeay and OpenSSL.
42*2175Sjp161948
43*2175Sjp161948=cut
44