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
|
<?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_string_output_flush">
<refmeta>
<refentrytitle>string_output_flush</refentrytitle>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>string_output_flush</refname>
<refpurpose>resets the state of the string_output object</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_string_output_flush">
<funcprototype id="fproto_string_output_flush">
<funcdef><function>string_output_flush</function></funcdef>
<paramdef>inout <parameter>stream</parameter>any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>
This function resets the state of the string output object.
The string associated with the string output is dropped and is of 0 characters
after this call.
</para>
</refsect1>
<refsect1 id="params"><title>Parameters</title>
<refsect2><title>stream</title>
<para>stream to clear, must have been created by the string_output function.</para></refsect2>
</refsect1>
<refsect1 id="examples"><title>Examples</title>
<example id="ex_string_output_flush"><title>Flush the String Output Stream</title>
<programlisting>
<?vsp
declare ses nay;
ses := string_output ();
http ('this text never be displayed' , ses);
string_output_flush (ses);
http ('stream test' , ses);
http (string_output_string (ses));
?>
</programlisting>
</example>
</refsect1>
</refentry>
|
