1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="fn_http_file">
<refmeta>
<refentrytitle>http_file</refentrytitle>
<refmiscinfo>ws</refmiscinfo>
</refmeta>
<refnamediv>
<refname>http_file</refname>
<refpurpose>Send a file to the HTTP client</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_http_file">
<funcprototype id="fproto_http_file">
<funcdef>varchar <function>http_file</function></funcdef>
<paramdef>in <parameter>path</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_http_file"><title>Description</title>
<para>
This function causes the contents of the file specified by
path to be sent as the response of the calling request.
The file is not sent until the code calling this returns.
Content types etc. are defaulted based on the file's extension.
If this function is called, other output to the HTTP client
by the caller is discarded.
</para>
</refsect1>
<refsect1 id="params_http_file"><title>Parameters</title>
<refsect2><title>path</title><para>Path to the file to send</para></refsect2>
</refsect1>
<refsect1 id="examples_http_file"><title>Examples</title>
<example id="ex_http_file"><title>Sending A File To HTTP Client</title>
<programlisting>
<?vsp
http_file ('/index.html');
?>
</programlisting>
</example>
</refsect1>
</refentry>
|