Debian Codegraph @

www/c3ref/file_control.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>Low-Level Control Of Database 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: {file control} sqlite3_file_control -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Low-Level Control Of Database Files</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_file_control(sqlite3*, const char *zDbName, int op, void*);
125 </pre></blockquote>
126 <p>
127 The <a href="../c3ref/file_control.html">sqlite3_file_control()</a> interface makes a direct call to the
128 xFileControl method for the <a href="../c3ref/io_methods.html">sqlite3_io_methods</a> object associated
129 with a particular database identified by the second argument. The
130 name of the database is "main" for the main database or "temp" for the
131 TEMP database, or the name that appears after the AS keyword for
132 databases that are added using the <a href="../lang_attach.html">ATTACH</a> SQL command.
133 A NULL pointer can be used in place of "main" to refer to the
134 main database file.
135 The third and fourth parameters to this routine
136 are passed directly through to the second and third parameters of
137 the xFileControl method. The return value of the xFileControl
138 method becomes the return value of this routine.</p>
139
140 <p>A few opcodes for <a href="../c3ref/file_control.html">sqlite3_file_control()</a> are handled directly
141 by the SQLite core and never invoke the
142 sqlite3_io_methods.xFileControl method.
143 The <a href="../c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlfilepointer">SQLITE_FCNTL_FILE_POINTER</a> value for the op parameter causes
144 a pointer to the underlying <a href="../c3ref/file.html">sqlite3_file</a> object to be written into
145 the space pointed to by the 4th parameter. The
146 <a href="../c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntljournalpointer">SQLITE_FCNTL_JOURNAL_POINTER</a> works similarly except that it returns
147 the <a href="../c3ref/file.html">sqlite3_file</a> object associated with the journal file instead of
148 the main database. The <a href="../c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntlvfspointer">SQLITE_FCNTL_VFS_POINTER</a> opcode returns
149 a pointer to the underlying <a href="../c3ref/vfs.html">sqlite3_vfs</a> object for the file.
150 The <a href="../c3ref/c_fcntl_begin_atomic_write.html#sqlitefcntldataversion">SQLITE_FCNTL_DATA_VERSION</a> returns the data version counter
151 from the pager.</p>
152
153 <p>If the second parameter (zDbName) does not match the name of any
154 open database file, then SQLITE_ERROR is returned. This error
155 code is not remembered and will not be recalled by <a href="../c3ref/errcode.html">sqlite3_errcode()</a>
156 or <a href="../c3ref/errcode.html">sqlite3_errmsg()</a>. The underlying xFileControl method might
157 also return SQLITE_ERROR. There is no way to distinguish between
158 an incorrect zDbName and an SQLITE_ERROR return from the underlying
159 xFileControl method.</p>
160
161 <p>See also: <a href="../c3ref/c_fcntl_begin_atomic_write.html">file control opcodes</a>
162 </p><p>See also lists of
163 <a href="../c3ref/objlist.html">Objects</a>,
164 <a href="../c3ref/constlist.html">Constants</a>, and
165 <a href="../c3ref/funclist.html">Functions</a>.</p>
166