1 files changed, 196 insertions, 0 deletions
diff --git a/www/c3ref/uri_boolean.html b/www/c3ref/uri_boolean.html
new file mode 100644
index 0000000..0412197
--- /dev/null
+++ b/www/c3ref/uri_boolean.html
@@ -0,0 +1,196 @@
+<!DOCTYPE html>
+<html><head>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<link href="../sqlite.css" rel="stylesheet">
+<title>Obtain Values For URI Parameters</title>
+<!-- path=../ -->
+</head>
+<body>
+<div class=nosearch>
+<a href="../index.html">
+<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
+</a>
+<div><!-- IE hack to prevent disappearing logo --></div>
+<div class="tagline desktoponly">
+Small. Fast. Reliable.<br>Choose any three.
+</div>
+<div class="menu mainmenu">
+<ul>
+<li><a href="../index.html">Home</a>
+<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
+<li class='wideonly'><a href='../about.html'>About</a>
+<li class='desktoponly'><a href="../docs.html">Documentation</a>
+<li class='desktoponly'><a href="../download.html">Download</a>
+<li class='wideonly'><a href='../copyright.html'>License</a>
+<li class='desktoponly'><a href="../support.html">Support</a>
+<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
+<li class='search' id='search_menubutton'>
+<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
+</ul>
+</div>
+<div class="menu submenu" id="submenu">
+<ul>
+<li><a href='../about.html'>About</a>
+<li><a href='../docs.html'>Documentation</a>
+<li><a href='../download.html'>Download</a>
+<li><a href='../support.html'>Support</a>
+<li><a href='../prosupport.html'>Purchase</a>
+</ul>
+</div>
+<div class="searchmenu" id="searchmenu">
+<form method="GET" action="../search">
+<select name="s" id="searchtype">
+<option value="d">Search Documentation</option>
+<option value="c">Search Changelog</option>
+</select>
+<input type="text" name="q" id="searchbox" value="">
+<input type="submit" value="Go">
+</form>
+</div>
+</div>
+<script>
+function toggle_div(nm) {
+var w = document.getElementById(nm);
+if( w.style.display=="block" ){
+w.style.display = "none";
+}else{
+w.style.display = "block";
+}
+}
+function toggle_search() {
+var w = document.getElementById("searchmenu");
+if( w.style.display=="block" ){
+w.style.display = "none";
+} else {
+w.style.display = "block";
+setTimeout(function(){
+document.getElementById("searchbox").focus()
+}, 30);
+}
+}
+function div_off(nm){document.getElementById(nm).style.display="none";}
+window.onbeforeunload = function(e){div_off("submenu");}
+/* Disable the Search feature if we are not operating from CGI, since */
+/* Search is accomplished using CGI and will not work without it. */
+if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
+document.getElementById("search_menubutton").style.display = "none";
+}
+/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
+function hideorshow(btn,obj){
+var x = document.getElementById(obj);
+var b = document.getElementById(btn);
+if( x.style.display!='none' ){
+x.style.display = 'none';
+b.innerHTML='show';
+}else{
+x.style.display = '';
+b.innerHTML='hide';
+}
+return false;
+}
+var antiRobot = 0;
+function antiRobotGo(){
+if( antiRobot!=3 ) return;
+antiRobot = 7;
+var j = document.getElementById("mtimelink");
+if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
+}
+function antiRobotDefense(){
+document.body.onmousedown=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousedown=null;
+}
+document.body.onmousemove=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousemove=null;
+}
+setTimeout(function(){
+antiRobot |= 1;
+antiRobotGo();
+}, 100)
+antiRobotGo();
+}
+antiRobotDefense();
+</script>
+<!-- keywords: sqlite3_uri_boolean sqlite3_uri_int64 sqlite3_uri_key sqlite3_uri_parameter -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Obtain Values For URI Parameters</h2>
+</div>
+<blockquote><pre>
+const char *sqlite3_uri_parameter(sqlite3_filename z, const char *zParam);
+int sqlite3_uri_boolean(sqlite3_filename z, const char *zParam, int bDefault);
+sqlite3_int64 sqlite3_uri_int64(sqlite3_filename, const char*, sqlite3_int64);
+const char *sqlite3_uri_key(sqlite3_filename z, int N);
+</pre></blockquote>
+<p>
+These are utility routines, useful to <a href="../vfs.html">custom VFS implementations</a>,
+that check if a database file was a URI that contained a specific query
+parameter, and if so obtains the value of that query parameter.</p>
+
+<p>The first parameter to these interfaces (hereafter referred to
+as F) must be one of:
+<ul>
+<li> A database filename pointer created by the SQLite core and
+passed into the xOpen() method of a VFS implementation, or
+<li> A filename obtained from <a href="../c3ref/db_filename.html">sqlite3_db_filename()</a>, or
+<li> A new filename constructed using <a href="../c3ref/create_filename.html">sqlite3_create_filename()</a>.
+</ul>
+If the F parameter is not one of the above, then the behavior is
+undefined and probably undesirable.  Older versions of SQLite were
+more tolerant of invalid F parameters than newer versions.</p>
+
+<p>If F is a suitable filename (as described in the previous paragraph)
+and if P is the name of the query parameter, then
+sqlite3_uri_parameter(F,P) returns the value of the P
+parameter if it exists or a NULL pointer if P does not appear as a
+query parameter on F.  If P is a query parameter of F and it
+has no explicit value, then sqlite3_uri_parameter(F,P) returns
+a pointer to an empty string.</p>
+
+<p>The sqlite3_uri_boolean(F,P,B) routine assumes that P is a boolean
+parameter and returns true (1) or false (0) according to the value
+of P.  The sqlite3_uri_boolean(F,P,B) routine returns true (1) if the
+value of query parameter P is one of "yes", "true", or "on" in any
+case or if the value begins with a non-zero number.  The
+sqlite3_uri_boolean(F,P,B) routines returns false (0) if the value of
+query parameter P is one of "no", "false", or "off" in any case or
+if the value begins with a numeric zero.  If P is not a query
+parameter on F or if the value of P does not match any of the
+above, then sqlite3_uri_boolean(F,P,B) returns (B!=0).</p>
+
+<p>The sqlite3_uri_int64(F,P,D) routine converts the value of P into a
+64-bit signed integer and returns that integer, or D if P does not
+exist.  If the value of P is something other than an integer, then
+zero is returned.</p>
+
+<p>The sqlite3_uri_key(F,N) returns a pointer to the name (not
+the value) of the N-th query parameter for filename F, or a NULL
+pointer if N is less than zero or greater than the number of query
+parameters minus 1.  The N value is zero-based so N should be 0 to obtain
+the name of the first query parameter, 1 for the second parameter, and
+so forth.</p>
+
+<p>If F is a NULL pointer, then sqlite3_uri_parameter(F,P) returns NULL and
+sqlite3_uri_boolean(F,P,B) returns B.  If F is not a NULL pointer and
+is not a database file pathname pointer that the SQLite core passed
+into the xOpen VFS method, then the behavior of this routine is undefined
+and probably undesirable.</p>
+
+<p>Beginning with SQLite <a href="../releaselog/3_31_0.html">version 3.31.0</a> (2020-01-22) the input F
+parameter can also be the name of a rollback journal file or WAL file
+in addition to the main database file.  Prior to version 3.31.0, these
+routines would only work if F was the name of the main database file.
+When the F parameter is the name of the rollback journal or WAL file,
+it has access to all the same query parameters as were found on the
+main database file.</p>
+
+<p>See the <a href="../uri.html">URI filename</a> documentation for additional information.
+</p><p>See also lists of
+  <a href="../c3ref/objlist.html">Objects</a>,
+  <a href="../c3ref/constlist.html">Constants</a>, and
+  <a href="../c3ref/funclist.html">Functions</a>.</p>
+