Dr. Stephen Henson | 0711be1 | 2002-10-20 13:20:57 +0000 | [diff] [blame] | 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 | |
Ulf Möller | c264592 | 2006-05-14 11:28:00 +0000 | [diff] [blame] | 10 | #include <openssl/asn1.h> |
| 11 | |
Dr. Stephen Henson | 0711be1 | 2002-10-20 13:20:57 +0000 | [diff] [blame] | 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>. |
Rich Salz | 0dfb939 | 2015-03-24 07:52:24 -0400 | [diff] [blame] | 25 | If B<a> is NULL nothing is done. |
Dr. Stephen Henson | 0711be1 | 2002-10-20 13:20:57 +0000 | [diff] [blame] | 26 | |
| 27 | =head1 NOTES |
| 28 | |
| 29 | Other string types call the B<ASN1_STRING> functions. For example |
| 30 | ASN1_OCTET_STRING_new() calls ASN1_STRING_type(V_ASN1_OCTET_STRING). |
| 31 | |
| 32 | =head1 RETURN VALUES |
| 33 | |
| 34 | ASN1_STRING_new() and ASN1_STRING_type_new() return a valid |
| 35 | ASN1_STRING structure or B<NULL> if an error occurred. |
| 36 | |
| 37 | ASN1_STRING_free() does not return a value. |
| 38 | |
| 39 | =head1 SEE ALSO |
| 40 | |
Rich Salz | 9b86974 | 2015-08-17 15:21:33 -0400 | [diff] [blame] | 41 | L<ERR_get_error(3)> |
Dr. Stephen Henson | 0711be1 | 2002-10-20 13:20:57 +0000 | [diff] [blame] | 42 | |
Rich Salz | e2f9261 | 2016-05-18 11:44:05 -0400 | [diff] [blame] | 43 | =head1 COPYRIGHT |
| 44 | |
| 45 | Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved. |
| 46 | |
| 47 | Licensed under the OpenSSL license (the "License"). You may not use |
| 48 | this file except in compliance with the License. You can obtain a copy |
| 49 | in the file LICENSE in the source distribution or at |
| 50 | L<https://www.openssl.org/source/license.html>. |
| 51 | |
| 52 | =cut |