Debian Codegraph @

www/c3ref/create_filename.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>Create and Destroy VFS Filenames</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_create_filename sqlite3_free_filename -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Create and Destroy VFS Filenames</h2>
122 </div>
123 <blockquote><pre>
124 sqlite3_filename sqlite3_create_filename(
125 const char *zDatabase,
126 const char *zJournal,
127 const char *zWal,
128 int nParam,
129 const char **azParam
130 );
131 void sqlite3_free_filename(sqlite3_filename);
132 </pre></blockquote>
133 <p>
134 These interfaces are provided for use by <a href="../vfs.html#shim">VFS shim</a> implementations and
135 are not useful outside of that context.</p>
136
137 <p>The sqlite3_create_filename(D,J,W,N,P) allocates memory to hold a version of
138 database filename D with corresponding journal file J and WAL file W and
139 an array P of N URI Key/Value pairs. The result from
140 sqlite3_create_filename(D,J,W,N,P) is a pointer to a database filename that
141 is safe to pass to routines like:
142 <ul>
143 <li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_parameter()</a>,
144 <li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_boolean()</a>,
145 <li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_int64()</a>,
146 <li> <a href="../c3ref/uri_boolean.html">sqlite3_uri_key()</a>,
147 <li> <a href="../c3ref/filename_database.html">sqlite3_filename_database()</a>,
148 <li> <a href="../c3ref/filename_database.html">sqlite3_filename_journal()</a>, or
149 <li> <a href="../c3ref/filename_database.html">sqlite3_filename_wal()</a>.
150 </ul>
151 If a memory allocation error occurs, sqlite3_create_filename() might
152 return a NULL pointer. The memory obtained from sqlite3_create_filename(X)
153 must be released by a corresponding call to sqlite3_free_filename(Y).</p>
154
155 <p>The P parameter in sqlite3_create_filename(D,J,W,N,P) should be an array
156 of 2*N pointers to strings. Each pair of pointers in this array corresponds
157 to a key and value for a query parameter. The P parameter may be a NULL
158 pointer if N is zero. None of the 2*N pointers in the P array may be
159 NULL pointers and key pointers should not be empty strings.
160 None of the D, J, or W parameters to sqlite3_create_filename(D,J,W,N,P) may
161 be NULL pointers, though they can be empty strings.</p>
162
163 <p>The sqlite3_free_filename(Y) routine releases a memory allocation
164 previously obtained from sqlite3_create_filename(). Invoking
165 sqlite3_free_filename(Y) where Y is a NULL pointer is a harmless no-op.</p>
166
167 <p>If the Y parameter to sqlite3_free_filename(Y) is anything other
168 than a NULL pointer or a pointer previously acquired from
169 sqlite3_create_filename(), then bad things such as heap
170 corruption or segfaults may occur. The value Y should not be
171 used again after sqlite3_free_filename(Y) has been called. This means
172 that if the <a href="../c3ref/vfs.html#sqlite3vfsxopen">sqlite3_vfs.xOpen()</a> method of a VFS has been called using Y,
173 then the corresponding [sqlite3_module.xClose() method should also be
174 invoked prior to calling sqlite3_free_filename(Y).
175 </p><p>See also lists of
176 <a href="../c3ref/objlist.html">Objects</a>,
177 <a href="../c3ref/constlist.html">Constants</a>, and
178 <a href="../c3ref/funclist.html">Functions</a>.</p>
179