03a309ba22e244615b1732034a96ffdec9b078a3
[openssl.git] / doc / internal / man3 / s2i_ASN1_UTF8STRING.pod
1 =pod
2
3 =head1 NAME
4
5 i2s_ASN1_UTF8STRING,
6 s2i_ASN1_UTF8STRING,
7 - convert objects from/to ASN.1/string representation
8
9 =head1 SYNOPSIS
10
11 =for openssl generic
12
13  char *i2s_ASN1_UTF8STRING(X509V3_EXT_METHOD *method,
14                            ASN1_UTF8STRING *utf8);
15  ASN1_UTF8STRING *s2i_ASN1_UTF8STRING(X509V3_EXT_METHOD *method,
16                                       X509V3_CTX *ctx, const char *str);
17 =head1 DESCRIPTION
18
19 These functions convert OpenSSL objects to and from their ASN.1/string
20 representation. This function is used for B<X509v3> extentions.
21
22 =head1 NOTES
23
24 The letters B<i> and B<s> in B<i2s_ASN1_UTF8STRING>() stand for
25 "internal" (that is, an internal C structure) and string respectively.
26 So B<i2s_ASN1_UTF8STRING>() converts from internal to string.
27
28 =head1 RETURN VALUES
29
30 B<s2i_ASN1_UTF8STRING>() return a valid
31 B<ASN1_UTF8STRING> structure or NULL if an error occurs.
32
33 B<i2s_ASN1_UTF8STRING>() returns the pointer to a UTF-8 string
34 or NULL if an error occurs.
35
36 =head1 COPYRIGHT
37
38 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
39
40 Licensed under the Apache License 2.0 (the "License").  You may not use
41 this file except in compliance with the License.  You can obtain a copy
42 in the file LICENSE in the source distribution or at
43 L<https://www.openssl.org/source/license.html>.
44
45 =cut