diff options
Diffstat (limited to '')
-rw-r--r-- | src/lib/libcrypto/man/ASN1_OBJECT_new.3 | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ASN1_OBJECT_new.3 b/src/lib/libcrypto/man/ASN1_OBJECT_new.3 new file mode 100644 index 0000000000..a636e7182e --- /dev/null +++ b/src/lib/libcrypto/man/ASN1_OBJECT_new.3 | |||
@@ -0,0 +1,61 @@ | |||
1 | .Dd August 12, 2014 | ||
2 | .Dt ASN1_OBJECT_NEW 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm ASN1_OBJECT_new , | ||
6 | .Nm ASN1_OBJECT_free | ||
7 | .Nd ASN1 object allocation functions | ||
8 | .Sh SYNOPSIS | ||
9 | .In openssl/asn1.h | ||
10 | .Ft ASN1_OBJECT * | ||
11 | .Fo ASN1_OBJECT_new | ||
12 | .Fa void | ||
13 | .Fc | ||
14 | .Ft void | ||
15 | .Fo ASN1_OBJECT_free | ||
16 | .Fa "ASN1_OBJECT *a" | ||
17 | .Fc | ||
18 | .Sh DESCRIPTION | ||
19 | The ASN1_OBJECT allocation routines allocate and free an | ||
20 | .Vt ASN1_OBJECT | ||
21 | structure, which represents an ASN1 OBJECT IDENTIFIER. | ||
22 | .Pp | ||
23 | .Fn ASN1_OBJECT_new | ||
24 | allocates and initializes an | ||
25 | .Vt ASN1_OBJECT | ||
26 | structure. | ||
27 | .Pp | ||
28 | .Fn ASN1_OBJECT_free | ||
29 | frees up the | ||
30 | .Vt ASN1_OBJECT | ||
31 | structure | ||
32 | .Fa a . | ||
33 | .Sh NOTES | ||
34 | Although | ||
35 | .Fn ASN1_OBJECT_new | ||
36 | allocates a new | ||
37 | .Vt ASN1_OBJECT | ||
38 | structure, it is almost never used in applications. | ||
39 | The ASN1 object utility functions such as | ||
40 | .Xr OBJ_nid2obj 3 | ||
41 | are used instead. | ||
42 | .Sh RETURN VALUES | ||
43 | If the allocation fails, | ||
44 | .Fn ASN1_OBJECT_new | ||
45 | returns | ||
46 | .Dv NULL | ||
47 | and sets an error code that can be obtained by | ||
48 | .Xr ERR_get_error 3 . | ||
49 | Otherwise it returns a pointer to the newly allocated structure. | ||
50 | .Pp | ||
51 | .Fn ASN1_OBJECT_free | ||
52 | returns no value. | ||
53 | .Sh SEE ALSO | ||
54 | .Xr d2i_ASN1_OBJECT 3 , | ||
55 | .Xr ERR_get_error 3 , | ||
56 | .Xr OBJ_nid2obj 3 | ||
57 | .Sh HISTORY | ||
58 | .Fn ASN1_OBJECT_new | ||
59 | and | ||
60 | .Fn ASN1_OBJECT_free | ||
61 | are available in all versions of SSLeay and OpenSSL. | ||