mirror of
https://github.com/ElvishArtisan/rivendell.git
synced 2025-04-09 22:43:11 +02:00
6a71c397a2
* Integrated the 'Rivendell-C-API' [from https://github.com/RadioFreeAsia/rivendell-c-api] in 'apis/rivwebcapi/'. * Added a 'rivendell-webapi' RPM subpackage.
53 lines
1.5 KiB
XML
53 lines
1.5 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<refentry id="stdin" xmlns="http://docbook.org/ns/docbook" version="5.0">
|
|
<!--
|
|
Header
|
|
-->
|
|
<refmeta>
|
|
<refentrytitle>RD_GetUserAgent</refentrytitle>
|
|
<manvolnum>7</manvolnum>
|
|
<refmiscinfo class='source'>September 2017</refmiscinfo>
|
|
<refmiscinfo class='manual'>Rivendell C Library Manual</refmiscinfo>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>rd_getuseragent</refname>
|
|
<refpurpose>Get User Agent Function</refpurpose>
|
|
</refnamediv>
|
|
<info>
|
|
<author>
|
|
<personname>
|
|
<firstname>Todd</firstname>
|
|
<surname>Baker</surname>
|
|
<email>bakert@rfa.org</email>
|
|
</personname>
|
|
<contrib>Rivendell C Library Author</contrib>
|
|
</author>
|
|
</info>
|
|
|
|
<!--
|
|
Body
|
|
-->
|
|
<refsynopsisdiv id='synopsis'>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>char * <function>RD_GetUserAgent</function></funcdef><void/>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id='description'><title>Description</title>
|
|
<para>
|
|
<command>RD_GetUserAgent</command> Returns the USER AGENT STRING
|
|
the Rivendell C API uses by default in the HTTP Header.
|
|
</para>
|
|
<para>
|
|
When successful function will return a character string of the USER AGENT.
|
|
</para>
|
|
</refsect1>
|
|
<refsect2 id='returns'><title>RETURN VALUE</title>
|
|
<para>
|
|
Returns the user agent as a character string.
|
|
</para>
|
|
</refsect2>
|
|
</refentry>
|