summaryrefslogtreecommitdiffstats
path: root/www/c3ref/create_filename.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/c3ref/create_filename.html')
-rw-r--r--www/c3ref/create_filename.html179
1 files changed, 179 insertions, 0 deletions
diff --git a/www/c3ref/create_filename.html b/www/c3ref/create_filename.html
new file mode 100644
index 0000000..c49f9de
--- /dev/null
+++ b/www/c3ref/create_filename.html
@@ -0,0 +1,179 @@
+<!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>Create and Destroy VFS Filenames</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_create_filename sqlite3_free_filename -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Create and Destroy VFS Filenames</h2>
+</div>
+<blockquote><pre>
+sqlite3_filename sqlite3_create_filename(
+ const char *zDatabase,
+ const char *zJournal,
+ const char *zWal,
+ int nParam,
+ const char **azParam
+);
+void sqlite3_free_filename(sqlite3_filename);
+</pre></blockquote>
+<p>
+These interfaces are provided for use by <a href="../vfs.html#shim">VFS shim</a> implementations and
+are not useful outside of that context.</p>
+
+<p>The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
+database filename D with corresponding journal file J and WAL file W and
+with N URI parameters key/values pairs in the array P. The result from
+sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
+is safe to pass to routines like:
+<ul>
+<li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_parameter()</a>,
+<li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_boolean()</a>,
+<li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_int64()</a>,
+<li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_key()</a>,
+<li> <a href="../c3ref/filename_database.html">sqlite3_filename_database()</a>,
+<li> <a href="../c3ref/filename_database.html">sqlite3_filename_journal()</a>, or
+<li> <a href="../c3ref/filename_database.html">sqlite3_filename_wal()</a>.
+</ul>
+If a memory allocation error occurs, sqlite3_create_filename() might
+return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
+must be released by a corresponding call to sqlite3_free_filename(Y).</p>
+
+<p>The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
+of 2*N pointers to strings. Each pair of pointers in this array corresponds
+to a key and value for a query parameter. The P parameter may be a NULL
+pointer if N is zero. None of the 2*N pointers in the P array may be
+NULL pointers and key pointers should not be empty strings.
+None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
+be NULL pointers, though they can be empty strings.</p>
+
+<p>The sqlite3_free_filename(Y) routine releases a memory allocation
+previously obtained from sqlite3_create_filename(). Invoking
+sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.</p>
+
+<p>If the Y parameter to sqlite3_free_filename(Y) is anything other
+than a NULL pointer or a pointer previously acquired from
+sqlite3_create_filename(), then bad things such as heap
+corruption or segfaults may occur. The value Y should not be
+used again after sqlite3_free_filename(Y) has been called. This means
+that if the <a href="../c3ref/vfs.html#sqlite3vfsxopen">sqlite3_vfs.xOpen()</a> method of a VFS has been called using Y,
+then the corresponding [sqlite3_module.xClose() method should also be
+invoked prior to calling sqlite3_free_filename(Y).
+</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>
+