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