Debian Codegraph @

www/c3ref/temp_directory.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>Name Of The Folder Holding Temporary Files</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_temp_directory -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Name Of The Folder Holding Temporary Files</h2>
122 </div>
123 <blockquote><pre>
124 SQLITE_EXTERN char *sqlite3_temp_directory;
125 </pre></blockquote>
126 <p>
127 If this global variable is made to point to a string which is
128 the name of a folder (a.k.a. directory), then all temporary files
129 created by SQLite when using a built-in <a href="../c3ref/vfs.html">VFS</a>
130 will be placed in that directory. If this variable
131 is a NULL pointer, then SQLite performs a search for an appropriate
132 temporary file directory.</p>
133
134 <p>Applications are strongly discouraged from using this global variable.
135 It is required to set a temporary folder on Windows Runtime (WinRT).
136 But for all other platforms, it is highly recommended that applications
137 neither read nor write this variable. This global variable is a relic
138 that exists for backwards compatibility of legacy applications and should
139 be avoided in new projects.</p>
140
141 <p>It is not safe to read or modify this variable in more than one
142 thread at a time. It is not safe to read or modify this variable
143 if a <a href="../c3ref/sqlite3.html">database connection</a> is being used at the same time in a separate
144 thread.
145 It is intended that this variable be set once
146 as part of process initialization and before any SQLite interface
147 routines have been called and that this variable remain unchanged
148 thereafter.</p>
149
150 <p>The <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> may modify this variable and cause
151 it to point to memory obtained from <a href="../c3ref/free.html">sqlite3_malloc</a>. Furthermore,
152 the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> always assumes that any string
153 that this variable points to is held in memory obtained from
154 <a href="../c3ref/free.html">sqlite3_malloc</a> and the pragma may attempt to free that memory
155 using <a href="../c3ref/free.html">sqlite3_free</a>.
156 Hence, if this variable is modified directly, either it should be
157 made NULL or made to point to memory obtained from <a href="../c3ref/free.html">sqlite3_malloc</a>
158 or else the use of the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> should be avoided.
159 Except when requested by the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a>, SQLite
160 does not free the memory that sqlite3_temp_directory points to. If
161 the application wants that memory to be freed, it must do
162 so itself, taking care to only do so after all <a href="../c3ref/sqlite3.html">database connection</a>
163 objects have been destroyed.</p>
164
165 <p><b>Note to Windows Runtime users:</b> The temporary directory must be set
166 prior to calling <a href="../c3ref/open.html">sqlite3_open</a> or <a href="../c3ref/open.html">sqlite3_open_v2</a>. Otherwise, various
167 features that require the use of temporary files may fail. Here is an
168 example of how to do this using C++ with the Windows Runtime:</p>
169
170 <p><blockquote><pre>
171 LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
172 &nbsp; TemporaryFolder->Path->Data();
173 char zPathBuf&#91;MAX_PATH + 1&#93;;
174 memset(zPathBuf, 0, sizeof(zPathBuf));
175 WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
176 &nbsp; NULL, NULL);
177 sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
178 </pre></blockquote>
179 </p><p>See also lists of
180 <a href="../c3ref/objlist.html">Objects</a>,
181 <a href="../c3ref/constlist.html">Constants</a>, and
182 <a href="../c3ref/funclist.html">Functions</a>.</p>
183