diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manual.xml | 2 | ||||
-rw-r--r-- | doc/ref/feat.xml | 89 |
2 files changed, 91 insertions, 0 deletions
diff --git a/doc/manual.xml b/doc/manual.xml index d3880b6..dab4c6b 100644 --- a/doc/manual.xml +++ b/doc/manual.xml @@ -68,6 +68,7 @@ <!ENTITY refshave SYSTEM "ref/shave.xml"> <!ENTITY refvers SYSTEM "ref/vers.xml"> <!ENTITY refinit SYSTEM "ref/init.xml"> +<!ENTITY reffeat SYSTEM "ref/feat.xml"> <!ENTITY refresolve SYSTEM "ref/resolve.xml"> <!ENTITY refiaddr SYSTEM "ref/iaddr.xml"> <!ENTITY refclicert SYSTEM "ref/clicert.xml"> @@ -153,6 +154,7 @@ ignoring the WebDAV support if desired.</para> &refbufdest; <!-- ne_buffer_destroy --> &referr; <!-- ne_get_error --> &refgetst; <!-- ne_get_status --> + &reffeat; <!-- ne_has_support --> &refiaddr; <!-- ne_iaddr_make --> &refalloc; <!-- ne_malloc --> &refsess; <!-- ne_session_create --> diff --git a/doc/ref/feat.xml b/doc/ref/feat.xml new file mode 100644 index 0000000..5413481 --- /dev/null +++ b/doc/ref/feat.xml @@ -0,0 +1,89 @@ +<refentry id="refXXXX"> + + <refmeta> + <refentrytitle>ne_has_support</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname id="ne_has_support">ne_has_support</refname> + <refpurpose>determine feature support status</refpurpose> + </refnamediv> + + <refsynopsisdiv> + + <funcsynopsis> + + <funcsynopsisinfo>#include <ne_utils.h></funcsynopsisinfo> + + <funcprototype> + <funcdef>int <function>ne_has_support</function></funcdef> + <paramdef>int <parameter>feature</parameter></paramdef> + </funcprototype> + + </funcsynopsis> + + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>The <function>ne_has_support</function> can be used to + determine whether a particular optional feature, given by the + feature code <parameter>feature</parameter>, is supported. The + following feature codes are available: + + <variablelist> + <varlistentry> + <term><constant>NE_FEATURE_SSL</constant></term> + <listitem> + <simpara>Indicates support for SSL/TLS</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>NE_FEATURE_ZLIB</constant></term> + <listitem> + <simpara>Indicates support for compressed responses</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>NE_FEATURE_IPV6</constant></term> + <listitem> + <simpara>Indicates support for IPv6</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>NE_FEATURE_LFS</constant></term> + <listitem> + <simpara>Indicates support for large files</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>NE_FEATURE_SOCKS</constant></term> + <listitem> + <simpara>Indicates support for SOCKSv5</simpara> + </listitem> + </varlistentry> + <varlistentry> + <term><constant>NE_FEATURE_TS_SSL</constant></term> + <listitem> + <simpara>Indicates support for thread-safe SSL + initialization</simpara> + </listitem> + </varlistentry> + </variablelist> + + </para> + + </refsect1> + + <refsect1> + <title>Return value</title> + + <para><function>ne_has_support</function> returns non-zero if + the given feature is supported, or zero otherwise.</para> + + </refsect1> + +</refentry> + |