159 lines
6.4 KiB
HTML
159 lines
6.4 KiB
HTML
<!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>Name Of The Folder Holding Temporary Files</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;
|
|
}
|
|
</script>
|
|
</div>
|
|
<!-- keywords: sqlite3_temp_directory -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Name Of The Folder Holding Temporary Files</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
SQLITE_EXTERN char *sqlite3_temp_directory;
|
|
</pre></blockquote>
|
|
<p>
|
|
If this global variable is made to point to a string which is
|
|
the name of a folder (a.k.a. directory), then all temporary files
|
|
created by SQLite when using a built-in <a href="../c3ref/vfs.html">VFS</a>
|
|
will be placed in that directory. If this variable
|
|
is a NULL pointer, then SQLite performs a search for an appropriate
|
|
temporary file directory.</p>
|
|
|
|
<p>Applications are strongly discouraged from using this global variable.
|
|
It is required to set a temporary folder on Windows Runtime (WinRT).
|
|
But for all other platforms, it is highly recommended that applications
|
|
neither read nor write this variable. This global variable is a relic
|
|
that exists for backwards compatibility of legacy applications and should
|
|
be avoided in new projects.</p>
|
|
|
|
<p>It is not safe to read or modify this variable in more than one
|
|
thread at a time. It is not safe to read or modify this variable
|
|
if a <a href="../c3ref/sqlite3.html">database connection</a> is being used at the same time in a separate
|
|
thread.
|
|
It is intended that this variable be set once
|
|
as part of process initialization and before any SQLite interface
|
|
routines have been called and that this variable remain unchanged
|
|
thereafter.</p>
|
|
|
|
<p>The <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> may modify this variable and cause
|
|
it to point to memory obtained from <a href="../c3ref/free.html">sqlite3_malloc</a>. Furthermore,
|
|
the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> always assumes that any string
|
|
that this variable points to is held in memory obtained from
|
|
<a href="../c3ref/free.html">sqlite3_malloc</a> and the pragma may attempt to free that memory
|
|
using <a href="../c3ref/free.html">sqlite3_free</a>.
|
|
Hence, if this variable is modified directly, either it should be
|
|
made NULL or made to point to memory obtained from <a href="../c3ref/free.html">sqlite3_malloc</a>
|
|
or else the use of the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a> should be avoided.
|
|
Except when requested by the <a href="../pragma.html#pragma_temp_store_directory">temp_store_directory pragma</a>, SQLite
|
|
does not free the memory that sqlite3_temp_directory points to. If
|
|
the application wants that memory to be freed, it must do
|
|
so itself, taking care to only do so after all <a href="../c3ref/sqlite3.html">database connection</a>
|
|
objects have been destroyed.</p>
|
|
|
|
<p><b>Note to Windows Runtime users:</b> The temporary directory must be set
|
|
prior to calling <a href="../c3ref/open.html">sqlite3_open</a> or <a href="../c3ref/open.html">sqlite3_open_v2</a>. Otherwise, various
|
|
features that require the use of temporary files may fail. Here is an
|
|
example of how to do this using C++ with the Windows Runtime:</p>
|
|
|
|
<p><blockquote><pre>
|
|
LPCWSTR zPath = Windows::Storage::ApplicationData::Current->
|
|
TemporaryFolder->Path->Data();
|
|
char zPathBuf[MAX_PATH + 1];
|
|
memset(zPathBuf, 0, sizeof(zPathBuf));
|
|
WideCharToMultiByte(CP_UTF8, 0, zPath, -1, zPathBuf, sizeof(zPathBuf),
|
|
NULL, NULL);
|
|
sqlite3_temp_directory = sqlite3_mprintf("%s", zPathBuf);
|
|
</pre></blockquote>
|
|
</p><p>See also lists of
|
|
<a href="objlist.html">Objects</a>,
|
|
<a href="constlist.html">Constants</a>, and
|
|
<a href="funclist.html">Functions</a>.</p>
|