Debian Codegraph @

www/c3ref/uri_boolean.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>Obtain Values For URI Parameters</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_uri_boolean sqlite3_uri_int64 sqlite3_uri_key sqlite3_uri_parameter -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Obtain Values For URI Parameters</h2>
122 </div>
123 <blockquote><pre>
124 const char *sqlite3_uri_parameter(sqlite3_filename z, const char *zParam);
125 int sqlite3_uri_boolean(sqlite3_filename z, const char *zParam, int bDefault);
126 sqlite3_int64 sqlite3_uri_int64(sqlite3_filename, const char*, sqlite3_int64);
127 const char *sqlite3_uri_key(sqlite3_filename z, int N);
128 </pre></blockquote>
129 <p>
130 These are utility routines, useful to <a href="../vfs.html">custom VFS implementations</a>,
131 that check if a database file was a URI that contained a specific query
132 parameter, and if so obtains the value of that query parameter.</p>
133
134 <p>The first parameter to these interfaces (hereafter referred to
135 as F) must be one of:
136 <ul>
137 <li> A database filename pointer created by the SQLite core and
138 passed into the xOpen() method of a VFS implementation, or
139 <li> A filename obtained from <a href="../c3ref/db_filename.html">sqlite3_db_filename()</a>, or
140 <li> A new filename constructed using <a href="../c3ref/create_filename.html">sqlite3_create_filename()</a>.
141 </ul>
142 If the F parameter is not one of the above, then the behavior is
143 undefined and probably undesirable. Older versions of SQLite were
144 more tolerant of invalid F parameters than newer versions.</p>
145
146 <p>If F is a suitable filename (as described in the previous paragraph)
147 and if P is the name of the query parameter, then
148 sqlite3_uri_parameter(F,P) returns the value of the P
149 parameter if it exists or a NULL pointer if P does not appear as a
150 query parameter on F. If P is a query parameter of F and it
151 has no explicit value, then sqlite3_uri_parameter(F,P) returns
152 a pointer to an empty string.</p>
153
154 <p>The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
155 parameter and returns true (1) or false (0) according to the value
156 of P. The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
157 value of query parameter P is one of "yes", "true", or "on" in any
158 case or if the value begins with a non-zero number. The
159 sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
160 query parameter P is one of "no", "false", or "off" in any case or
161 if the value begins with a numeric zero. If P is not a query
162 parameter on F or if the value of P does not match any of the
163 above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).</p>
164
165 <p>The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
166 64-bit signed integer and returns that integer, or D if P does not
167 exist. If the value of P is something other than an integer, then
168 zero is returned.</p>
169
170 <p>The sqlite3_uri_key(F,N) returns a pointer to the name (not
171 the value) of the N-th query parameter for filename F, or a NULL
172 pointer if N is less than zero or greater than the number of query
173 parameters minus 1. The N value is zero-based so N should be 0 to obtain
174 the name of the first query parameter, 1 for the second parameter, and
175 so forth.</p>
176
177 <p>If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
178 sqlite3_uri_boolean(F,P,B) returns B. If F is not a NULL pointer and
179 is not a database file pathname pointer that the SQLite core passed
180 into the xOpen VFS method, then the behavior of this routine is undefined
181 and probably undesirable.</p>
182
183 <p>Beginning with SQLite <a href="../releaselog/3_31_0.html">version 3.31.0</a> (2020-01-22) the input F
184 parameter can also be the name of a rollback journal file or WAL file
185 in addition to the main database file. Prior to version 3.31.0, these
186 routines would only work if F was the name of the main database file.
187 When the F parameter is the name of the rollback journal or WAL file,
188 it has access to all the same query parameters as were found on the
189 main database file.</p>
190
191 <p>See the <a href="../uri.html">URI filename</a> documentation for additional information.
192 </p><p>See also lists of
193 <a href="../c3ref/objlist.html">Objects</a>,
194 <a href="../c3ref/constlist.html">Constants</a>, and
195 <a href="../c3ref/funclist.html">Functions</a>.</p>
196