338b72653e52f5d1e9a4983d09f95b0ca896f1cc
[openssl.git] / doc / crypto / ASN1_OBJECT_new.pod
1 =pod
2
3 =head1 NAME
4
5 ASN1_OBJECT_new, ASN1_OBJECT_free - object allocation functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/asn1.h>
10
11  ASN1_OBJECT *ASN1_OBJECT_new(void);
12  void ASN1_OBJECT_free(ASN1_OBJECT *a);
13
14 =head1 DESCRIPTION
15
16 The ASN1_OBJECT allocation routines, allocate and free an
17 ASN1_OBJECT structure, which represents an ASN1 OBJECT IDENTIFIER.
18
19 ASN1_OBJECT_new() allocates and initializes a ASN1_OBJECT structure.
20
21 ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure B<a>.
22
23 =head1 NOTES
24
25 Although ASN1_OBJECT_new() allocates a new ASN1_OBJECT structure it
26 is almost never used in applications. The ASN1 object utility functions
27 such as OBJ_nid2obj() are used instead.
28
29 =head1 RETURN VALUES
30
31 If the allocation fails, ASN1_OBJECT_new() returns B<NULL> and sets an error
32 code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
33 Otherwise it returns a pointer to the newly allocated structure.
34
35 ASN1_OBJECT_free() returns no value.
36
37 =head1 SEE ALSO
38
39 L<ERR_get_error(3)|ERR_get_error(3)>, L<d2i_ASN1_OBJECT(3)|d2i_ASN1_OBJECT(3)>
40
41 =head1 HISTORY
42
43 ASN1_OBJECT_new() and ASN1_OBJECT_free() are available in all versions of SSLeay and OpenSSL.
44
45 =cut