Debian Codegraph @

www/c3ref/mprintf.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta name="viewport" content="width=device-width, initial-scale=1.0">
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
5 <link href="../sqlite.css" rel="stylesheet">
6 <title>Formatted String Printing Functions</title>
7 <!-- path=../ -->
8 </head>
9 <body>
10 <div class=nosearch>
11 <a href="../index.html">
12 <img class="logo" src="../images/sqlite370_banner.svg" alt="SQLite" border="0">
13 </a>
14 <div><!-- IE hack to prevent disappearing logo --></div>
15 <div class="tagline desktoponly">
16 Small. Fast. Reliable.<br>Choose any three.
17 </div>
18 <div class="menu mainmenu">
19 <ul>
20 <li><a href="../index.html">Home</a>
21 <li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
22 <li class='wideonly'><a href='../about.html'>About</a>
23 <li class='desktoponly'><a href="../docs.html">Documentation</a>
24 <li class='desktoponly'><a href="../download.html">Download</a>
25 <li class='wideonly'><a href='../copyright.html'>License</a>
26 <li class='desktoponly'><a href="../support.html">Support</a>
27 <li class='desktoponly'><a href="../prosupport.html">Purchase</a>
28 <li class='search' id='search_menubutton'>
29 <a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
30 </ul>
31 </div>
32 <div class="menu submenu" id="submenu">
33 <ul>
34 <li><a href='../about.html'>About</a>
35 <li><a href='../docs.html'>Documentation</a>
36 <li><a href='../download.html'>Download</a>
37 <li><a href='../support.html'>Support</a>
38 <li><a href='../prosupport.html'>Purchase</a>
39 </ul>
40 </div>
41 <div class="searchmenu" id="searchmenu">
42 <form method="GET" action="../search">
43 <select name="s" id="searchtype">
44 <option value="d">Search Documentation</option>
45 <option value="c">Search Changelog</option>
46 </select>
47 <input type="text" name="q" id="searchbox" value="">
48 <input type="submit" value="Go">
49 </form>
50 </div>
51 </div>
52 <script>
53 function toggle_div(nm) {
54 var w = document.getElementById(nm);
55 if( w.style.display=="block" ){
56 w.style.display = "none";
57 }else{
58 w.style.display = "block";
59 }
60 }
61 function toggle_search() {
62 var w = document.getElementById("searchmenu");
63 if( w.style.display=="block" ){
64 w.style.display = "none";
65 } else {
66 w.style.display = "block";
67 setTimeout(function(){
68 document.getElementById("searchbox").focus()
69 }, 30);
70 }
71 }
72 function div_off(nm){document.getElementById(nm).style.display="none";}
73 window.onbeforeunload = function(e){div_off("submenu");}
74 /* Disable the Search feature if we are not operating from CGI, since */
75 /* Search is accomplished using CGI and will not work without it. */
76 if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
77 document.getElementById("search_menubutton").style.display = "none";
78 }
79 /* Used by the Hide/Show button beside syntax diagrams, to toggle the */
80 function hideorshow(btn,obj){
81 var x = document.getElementById(obj);
82 var b = document.getElementById(btn);
83 if( x.style.display!='none' ){
84 x.style.display = 'none';
85 b.innerHTML='show';
86 }else{
87 x.style.display = '';
88 b.innerHTML='hide';
89 }
90 return false;
91 }
92 var antiRobot = 0;
93 function antiRobotGo(){
94 if( antiRobot!=3 ) return;
95 antiRobot = 7;
96 var j = document.getElementById("mtimelink");
97 if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
98 }
99 function antiRobotDefense(){
100 document.body.onmousedown=function(){
101 antiRobot |= 2;
102 antiRobotGo();
103 document.body.onmousedown=null;
104 }
105 document.body.onmousemove=function(){
106 antiRobot |= 2;
107 antiRobotGo();
108 document.body.onmousemove=null;
109 }
110 setTimeout(function(){
111 antiRobot |= 1;
112 antiRobotGo();
113 }, 100)
114 antiRobotGo();
115 }
116 antiRobotDefense();
117 </script>
118 <!-- keywords: sqlite3_mprintf sqlite3_snprintf sqlite3_vmprintf sqlite3_vsnprintf -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Formatted String Printing Functions</h2>
122 </div>
123 <blockquote><pre>
124 char *sqlite3_mprintf(const char*,...);
125 char *sqlite3_vmprintf(const char*, va_list);
126 char *sqlite3_snprintf(int,char*,const char*, ...);
127 char *sqlite3_vsnprintf(int,char*,const char*, va_list);
128 </pre></blockquote>
129 <p>
130 These routines are work-alikes of the "printf()" family of functions
131 from the standard C library.
132 These routines understand most of the common formatting options from
133 the standard library printf()
134 plus some additional non-standard formats (<a href="../printf.html#percentq">%q</a>, <a href="../printf.html#percentq">%Q</a>, <a href="../printf.html#percentw">%w</a>, and <a href="../printf.html#percentz">%z</a>).
135 See the <a href="../printf.html">built-in printf()</a> documentation for details.</p>
136
137 <p>The sqlite3_mprintf() and sqlite3_vmprintf() routines write their
138 results into memory obtained from <a href="../c3ref/free.html">sqlite3_malloc64()</a>.
139 The strings returned by these two routines should be
140 released by <a href="../c3ref/free.html">sqlite3_free()</a>. Both routines return a
141 NULL pointer if <a href="../c3ref/free.html">sqlite3_malloc64()</a> is unable to allocate enough
142 memory to hold the resulting string.</p>
143
144 <p>The sqlite3_snprintf() routine is similar to "snprintf()" from
145 the standard C library. The result is written into the
146 buffer supplied as the second parameter whose size is given by
147 the first parameter. Note that the order of the
148 first two parameters is reversed from snprintf(). This is an
149 historical accident that cannot be fixed without breaking
150 backwards compatibility. Note also that sqlite3_snprintf()
151 returns a pointer to its buffer instead of the number of
152 characters actually written into the buffer. We admit that
153 the number of characters written would be a more useful return
154 value but we cannot change the implementation of sqlite3_snprintf()
155 now without breaking compatibility.</p>
156
157 <p>As long as the buffer size is greater than zero, sqlite3_snprintf()
158 guarantees that the buffer is always zero-terminated. The first
159 parameter "n" is the total size of the buffer, including space for
160 the zero terminator. So the longest string that can be completely
161 written will be n-1 characters.</p>
162
163 <p>The sqlite3_vsnprintf() routine is a varargs version of sqlite3_snprintf().</p>
164
165 <p>See also: <a href="../printf.html">built-in printf()</a>, <a href="../lang_corefunc.html#printf">printf() SQL function</a>
166 </p><p>See also lists of
167 <a href="../c3ref/objlist.html">Objects</a>,
168 <a href="../c3ref/constlist.html">Constants</a>, and
169 <a href="../c3ref/funclist.html">Functions</a>.</p>
170