File: http_rewrite.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (78 lines) | stat: -rw-r--r-- 2,988 bytes parent folder | download | duplicates (2)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
<?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_rewrite">
  <refmeta>
    <refentrytitle>http_rewrite</refentrytitle>
    <refmiscinfo>ws</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>http_rewrite</refname>
    <refpurpose>Clears output written to  a string output or to an HTTP    </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_http_rewrite">
      <funcprototype id="fproto_http_rewrite">
        <funcdef><function>http_rewrite</function></funcdef>
        <paramdef><optional>in <parameter>stream</parameter> any</optional></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_http_rewrite"><title>Description</title>
    <para>
This clears any previous output to the stream. If the stream is omitted or 0 the stream
is the HTTP client stream of the calling procedure.
</para>
<para>All output from VSP page procedures is buffered into a local string stream
before being sent out.  This is done so as to support the HTTP/1.1 required
content length and to allow recovery from errors.
</para>
  </refsect1>
  <refsect1 id="params_http_rewrite"><title>Parameters</title>
    <refsect2><title>stream</title>
      <para>Optional stream to clear. Null or zero (0) implies the default HTTP client stream.</para></refsect2>
  </refsect1>
  <refsect1 id="examples_http_rewrite"><title>Using http_rewrite()</title>
  <example id="ex_http_rewrite">
    <para>A VSP page excerpt.</para>
    <programlisting>
&lt;p&gt;Nope. You won't see this.&lt;/p&gt;

&lt;?vsp
http ('&lt;p&gt;This line will contribute to your local entropy.&lt;/p&gt;');
http_rewrite ();
http ('&lt;p&gt;Now THIS is what you wanted to see, isn't it?&lt;/p&gt;');
?&gt;
    </programlisting>
  </example>
  </refsect1>
  <refsect1 id="seealso_http_rewrite"><title>See Also</title>
    <para>
      <link linkend="fn_http_value"><function>http_value</function></link>,
      <link linkend="fn_http_url"><function>http_url</function></link>,
      <link linkend="fn_string_output"><function>string_output</function></link>.
    </para>
  </refsect1>
</refentry>