xref: /openssl/doc/man3/ASN1_OBJECT_new.pod (revision 723e9c89)
1=pod
2
3=head1 NAME
4
5ASN1_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
16The B<ASN1_OBJECT> allocation routines, allocate and free an
17B<ASN1_OBJECT> structure, which represents an ASN1 OBJECT IDENTIFIER.
18
19ASN1_OBJECT_new() allocates and initializes an B<ASN1_OBJECT> structure.
20
21ASN1_OBJECT_free() frees up the B<ASN1_OBJECT> structure I<a>.
22If I<a> is NULL, nothing is done.
23
24=head1 NOTES
25
26Although ASN1_OBJECT_new() allocates a new B<ASN1_OBJECT> structure it
27is almost never used in applications. The ASN1 object utility functions
28such as OBJ_nid2obj() are used instead.
29
30=head1 RETURN VALUES
31
32If the allocation fails, ASN1_OBJECT_new() returns NULL and sets an error
33code that can be obtained by L<ERR_get_error(3)>.
34Otherwise it returns a pointer to the newly allocated structure.
35
36ASN1_OBJECT_free() returns no value.
37
38=head1 SEE ALSO
39
40L<ERR_get_error(3)>, L<d2i_ASN1_OBJECT(3)>
41
42=head1 COPYRIGHT
43
44Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
45
46Licensed under the Apache License 2.0 (the "License").  You may not use
47this file except in compliance with the License.  You can obtain a copy
48in the file LICENSE in the source distribution or at
49L<https://www.openssl.org/source/license.html>.
50
51=cut
52