PKCS5_PBKDF2_HMAC documentation submitted by Jeffrey Walton
[openssl.git] / doc / crypto / ASN1_STRING_new.pod
1 =pod
2
3 =head1 NAME
4
5 ASN1_STRING_new, ASN1_STRING_type_new, ASN1_STRING_free -
6 ASN1_STRING allocation functions
7
8 =head1 SYNOPSIS
9
10  #include <openssl/asn1.h>
11
12  ASN1_STRING * ASN1_STRING_new(void);
13  ASN1_STRING * ASN1_STRING_type_new(int type);
14  void ASN1_STRING_free(ASN1_STRING *a);
15
16 =head1 DESCRIPTION
17
18 ASN1_STRING_new() returns an allocated B<ASN1_STRING> structure. Its type
19 is undefined.
20
21 ASN1_STRING_type_new() returns an allocated B<ASN1_STRING> structure of
22 type B<type>.
23
24 ASN1_STRING_free() frees up B<a>.
25
26 =head1 NOTES
27
28 Other string types call the B<ASN1_STRING> functions. For example
29 ASN1_OCTET_STRING_new() calls ASN1_STRING_type(V_ASN1_OCTET_STRING).
30
31 =head1 RETURN VALUES
32
33 ASN1_STRING_new() and ASN1_STRING_type_new() return a valid
34 ASN1_STRING structure or B<NULL> if an error occurred.
35
36 ASN1_STRING_free() does not return a value.
37
38 =head1 SEE ALSO
39
40 L<ERR_get_error(3)|ERR_get_error(3)>
41
42 =head1 HISTORY
43
44 TBA
45
46 =cut