File: dbg_printf.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 (84 lines) | stat: -rw-r--r-- 3,324 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
79
80
81
82
83
84
<?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_dbg_printf">
  <refmeta>
    <refentrytitle>dbg_printf</refentrytitle>
    <refmiscinfo>debug</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>dbg_printf</refname>
    <refpurpose>print formatted output onto the system console</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_dbg_printf">
      <funcprototype id="fproto_dbg_printf">
        <funcdef><function>dbg_printf</function></funcdef>
        <paramdef>in <parameter>format</parameter> varchar</paramdef>
        <paramdef>in <parameter>arg1</parameter> any</paramdef>
        <paramdef><parameter>...</parameter></paramdef>
        <paramdef>in <parameter>argn</parameter> any</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_dbg_printf"><title>Description</title>
      <para><function>dbg_printf</function> prints a variable number
      (max. eight) of arguments to the system console of Virtuoso server,
      each argument formatted in C <function>printf</function> style,
      according to the format string specified in the first argument.</para>
  </refsect1>
  <refsect1 id="params_dbg_printf"><title>Parameters</title>
    <refsect2><title>format</title>
      <para>a C sprintf -style format <type>string</type></para>
    </refsect2>
    <refsect2><title>argn</title>
      <para>The arguments to format and print in any type</para>
    </refsect2>
  </refsect1>
  <refsect1 id="ret_dbg_printf"><title>Return Values</title>
    <para>None</para>
  </refsect1>
  <refsect1 id="examples_dbg_printf"><title>Examples</title>
    <example id="ex_dbg_printf_1"><title>Simple example</title>
      <para>The frammitz just zilched!</para>
      <screen>
if (frammitz_status 0)
  {
    dbg_printf ('Error: Frammitz status: %d.\nProgram terminated',
                frammitz_status);
    signal ('42666', 'Frammitz zilched');
  }
</screen>
      <para>Hitting these lines would cause something like this in a client:</para>
      <screen>*** Error 42666: [Virtuoso Driver][Virtuoso Server]Frammitz zilched at line 84 (84) of Top-Level: zappi()
</screen>
      <para>The console output would look like this:</para>
      <screen>Error: Frammitz status: 2.
Program terminated
</screen>
    </example>
  </refsect1>
  <refsect1 id="seealso_dbg_printf"><title>See Also</title>
    <para><link linkend="fn_sprintf">sprintf</link></para>
  </refsect1>
</refentry>