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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
<?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_sprintf">
<refmeta>
<refentrytitle>sprintf</refentrytitle>
<refmiscinfo>string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sprintf</refname>
<refpurpose>returns a formatted string</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_sprintf">
<funcprototype id="fproto_sprintf">
<funcdef><function>sprintf</function></funcdef>
<paramdef><parameter>format</parameter> string</paramdef>
<paramdef><parameter>arg_1</parameter> any</paramdef>
<paramdef><parameter>...</parameter> </paramdef>
<paramdef><parameter>arg_x</parameter> any</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc"><title>Description</title>
<para>sprintf returns a new string formed by "printing" a variable number
of arguments arg_1 - arg_x according to the format string format,
that is, exactly the same way as with the sprintf function of C language.
However the sprintf function enforces some additional limitations over the sprintf C function.
It does not allow for single value output to take more than 2000 characters.
It does support the following additional format characters:
</para>
<para>
diouxXeEfgcs - as in the C language printf
</para>
<para>
S - as 's' but escapes the single quotes by doubling them (as per SQL/92). This is suitable for
constructing dynamic SQL statements with string literals inline.
</para>
<screen>
sprintf ('insert into testit (data) values ('%S')', 'Test ''Real'' data')
-> insert into testit (data) values ('Test ''Real'' data')
</screen>
<para>
I - as 's' but escapes the string value to form a valid identifier name (will double the double
quotes). This is suitable for constructing dynamic SQL statements with identifiers inline.
</para>
<screen>
sprintf ('select * from "%I"', 'Big "Table" Name')
-> select * from "Big ""Table"" Name"
</screen>
<para>
U - as 's' but escapes the string value as an HTTP URL (same as http_url() function). Useful for making
dynamic VSP content
</para>
<screen>
sprintf ('<a href="%U">', 'day & night')
-> <a href="day+%26+night">
</screen>
<para>
R - use to replace leading spaces: the modifiers are one of + - # 0 and space.
</para>
<screen>
sprintf ('%-R', ' 123')
-123
sprintf ('%-R', ' 123')
--123
</screen>
<para>
V - as 's' but escapes the string value as an HTTP Value (same as http_value). Useful for making
dynamic VSP content
</para>
<screen>
sprintf ('<INPUT name="test" value="%V">', 'day & night')
-> <INPUT name="test" value="day &amp; night">
</screen>
<para>
Note that the sprintf format length and precision modifiers do not apply to the extension format characters
</para>
<screen>sprintf('Int=%d/%o/%x, String=%s, Character=%c',
42798,42798,42798,'la cadena',65)
-> 'Int=42798/123456/a72e, String=la cadena, Character=A'
</screen>
<para>In addition, <emphasis>%{varname}U</emphasis> syntax extension is supported, mostly for <link linkend="rdfconnvarsiniriclasses">uing connection variables in RDF IRI classes</link>. That syntax is to print the value of client connection variable <emphasis>varname</emphasis> using print format <emphasis>%U</emphasis>. Other format characters are not supported for that feature in current version of Virtuoso but might be supported in the future.</para>
</refsect1>
</refentry>
|
