1
2    <refentry id="refssldname">
3
4      <refmeta>
5	<refentrytitle>ne_ssl_dname</refentrytitle>
6	<manvolnum>3</manvolnum>
7      </refmeta>
8
9      <refnamediv>
10	<refname id="ne_ssl_readable_dname">ne_ssl_readable_dname</refname>
11        <refname id="ne_ssl_dname_cmp">ne_ssl_dname_cmp</refname>
12	<refpurpose>SSL distinguished name handling</refpurpose>
13      </refnamediv>
14      
15      <refsynopsisdiv>
16	
17	<funcsynopsis>
18
19	  <funcsynopsisinfo>#include &lt;ne_ssl.h&gt;</funcsynopsisinfo>
20
21	  <funcprototype>
22	    <funcdef>const char *<function>ne_ssl_readable_dname</function></funcdef>
23	    <paramdef>const ne_ssl_dname *<parameter>dname</parameter></paramdef>
24	  </funcprototype>
25
26	  <funcprototype>
27	    <funcdef>int <function>ne_ssl_dname_cmp</function></funcdef>
28	    <paramdef>const ne_ssl_dname *<parameter>dn1</parameter></paramdef>
29	    <paramdef>const ne_ssl_dname *<parameter>dn2</parameter></paramdef>
30	  </funcprototype>
31
32	</funcsynopsis>
33	
34      </refsynopsisdiv>
35
36      <refsect1>
37	<title>Description</title>
38
39	<para>The <function>ne_ssl_readable_dname</function> function
40creates a single-line, human-readable string out of an
41<type>ne_ssl_dname</type> object.  The returned string is
42<function>malloc</function>()-allocated, and must be
43<function>free</function>()d by the caller.</para>
44
45	<para>The <function>ne_ssl_dname_cmp</function> function
46	compares two distinguished names, and returns zero if they are
47	equal, or non-zero otherwise.</para>
48
49      </refsect1>
50
51      <refsect1>
52	<title>Return value</title>
53
54	<para><function>ne_ssl_readable_dname</function> returns a <function>malloc</function>-allocated
55        string, and never &null;.</para>
56
57      </refsect1>
58
59      <refsect1>
60	<title>Examples</title>
61
62        <para>See <xref linkend="ne_ssl_cert_subject"/> for an example
63        use of <function>ne_ssl_readable_dname</function>.</para>
64
65      </refsect1>
66
67      <refsect1>
68	<title>See also</title>
69
70	<para><xref linkend="ne_ssl_cert_subject"/></para>
71      </refsect1>
72
73    </refentry>
74