Nit about pod filenames
[openssl.git] / doc / crypto / d2i_X509_NAME.pod
1 =pod
2
3 =head1 NAME
4
5 d2i_X509_NAME, i2d_X509_NAME - X509_NAME encoding functions
6
7 =head1 SYNOPSIS
8
9  #include <openssl/x509.h>
10
11  X509_NAME *d2i_X509_NAME(X509_NAME **a, unsigned char **pp, long length);
12  int i2d_X509_NAME(X509_NAME *a, unsigned char **pp);
13
14  int X509_NAME_get0_der(const unsigned char **pder, size_t *pderlen,
15                         X509_NAME *nm)
16
17
18 =head1 DESCRIPTION
19
20 The functions d2i_X509_NAME() and i2d_X509_NAME() decode and encode an
21 B<X509_NAME> structure which is the same as the B<Name> type defined in
22 RFC3280 (and elsewhere) and used for example in certificate subject and
23 issuer names.
24
25 Otherwise the functions behave in a similar way to d2i_X509() and i2d_X509()
26 described in the L<d2i_X509(3)> manual page.
27
28 The function X509_NAME_get0_der() returns an internal pointer to the
29 encoding of an B<X509_NAME> structure in B<*pder> and consisting of
30 B<*pderlen> bytes. It is useful for applications that wish to examine
31 the encoding of an B<X509_NAME> structure without copying it.
32
33 =head1 RETURN VALUES
34
35 The meanings of the return values of d2i_X509_NAME() and i2d_X509_NAME()
36 are similar to those for d2i_X509() and i2d_X509().
37
38 The function X509_NAME_get0_der() returns 1 for success and 0 if an error
39 occurred.
40
41 =head1 SEE ALSO
42
43 L<d2i_X509(3)>
44
45 =head1 COPYRIGHT
46
47 Copyright 2002-2016 The OpenSSL Project Authors. All Rights Reserved.
48
49 Licensed under the OpenSSL license (the "License").  You may not use
50 this file except in compliance with the License.  You can obtain a copy
51 in the file LICENSE in the source distribution or at
52 L<https://www.openssl.org/source/license.html>.
53
54 =cut