Debian Codegraph @

www/c3ref/load_extension.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>Load An Extension</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_load_extension -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Load An Extension</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_load_extension(
125 sqlite3 *db, /* Load the extension into this database connection */
126 const char *zFile, /* Name of the shared library containing extension */
127 const char *zProc, /* Entry point. Derived from zFile if 0 */
128 char **pzErrMsg /* Put error message here if not 0 */
129 );
130 </pre></blockquote>
131 <p>
132 This interface loads an SQLite extension library from the named file.</p>
133
134 <p>The sqlite3_load_extension() interface attempts to load an
135 <a href="../loadext.html">SQLite extension</a> library contained in the file zFile. If
136 the file cannot be loaded directly, attempts are made to load
137 with various operating-system specific filename extensions added.
138 So for example, if "samplelib" cannot be loaded, then names like
139 "samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
140 be tried also.</p>
141
142 <p>The entry point is zProc.
143 zProc may be 0, in which case SQLite will try to come up with an
144 entry point name on its own. It first tries "sqlite3_extension_init".
145 If that does not work, it tries names of the form "sqlite3_X_init"
146 where X consists of the lower-case equivalent of all ASCII alphabetic
147 characters or all ASCII alphanumeric characters in the filename from
148 the last "/" to the first following "." and omitting any initial "lib".
149 The sqlite3_load_extension() interface returns
150 <a href="../rescode.html#ok">SQLITE_OK</a> on success and <a href="../rescode.html#error">SQLITE_ERROR</a> if something goes wrong.
151 If an error occurs and pzErrMsg is not 0, then the
152 <a href="../c3ref/load_extension.html">sqlite3_load_extension()</a> interface shall attempt to
153 fill *pzErrMsg with error message text stored in memory
154 obtained from <a href="../c3ref/free.html">sqlite3_malloc()</a>. The calling function
155 should free this memory by calling <a href="../c3ref/free.html">sqlite3_free()</a>.</p>
156
157 <p>Extension loading must be enabled using
158 <a href="../c3ref/enable_load_extension.html">sqlite3_enable_load_extension()</a> or
159 <a href="../c3ref/db_config.html">sqlite3_db_config</a>(db,<a href="../c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableloadextension">SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</a>,1,NULL)
160 prior to calling this API,
161 otherwise an error will be returned.</p>
162
163 <p><b>Security warning:</b> It is recommended that the
164 <a href="../c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableloadextension">SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</a> method be used to enable only this
165 interface. The use of the <a href="../c3ref/enable_load_extension.html">sqlite3_enable_load_extension()</a> interface
166 should be avoided. This will keep the SQL function <a href="../lang_corefunc.html#load_extension">load_extension()</a>
167 disabled and prevent SQL injections from giving attackers
168 access to extension loading capabilities.</p>
169
170 <p>See also the <a href="../lang_corefunc.html#load_extension">load_extension() SQL function</a>.
171 </p><p>See also lists of
172 <a href="../c3ref/objlist.html">Objects</a>,
173 <a href="../c3ref/constlist.html">Constants</a>, and
174 <a href="../c3ref/funclist.html">Functions</a>.</p>
175