Add auto-gen SM2 der files into .gitignore
[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  #include "crypto/x509v3.h"
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
18 =head1 DESCRIPTION
19
20 These functions convert OpenSSL objects to and from their ASN.1/string
21 representation. This function is used for B<X509v3> extensions.
22
23 =head1 NOTES
24
25 The letters B<i> and B<s> in i2s_ASN1_UTF8STRING() stand for
26 "internal" (that is, an internal C structure) and string respectively.
27 So B<i2s_ASN1_UTF8STRING>() converts from internal to string.
28
29 =head1 RETURN VALUES
30
31 B<s2i_ASN1_UTF8STRING>() return a valid
32 B<ASN1_UTF8STRING> structure or NULL if an error occurs.
33
34 B<i2s_ASN1_UTF8STRING>() returns the pointer to a UTF-8 string
35 or NULL if an error occurs.
36
37 =head1 COPYRIGHT
38
39 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
40
41 Licensed under the Apache License 2.0 (the "License").  You may not use
42 this file except in compliance with the License.  You can obtain a copy
43 in the file LICENSE in the source distribution or at
44 L<https://www.openssl.org/source/license.html>.
45
46 =cut