151 lines
6.0 KiB
HTML
151 lines
6.0 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>Load An Extension</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_load_extension -->
|
|
<div class=nosearch>
|
|
<a href="intro.html"><h2>SQLite C Interface</h2></a>
|
|
<h2>Load An Extension</h2>
|
|
</div>
|
|
<blockquote><pre>
|
|
int sqlite3_load_extension(
|
|
sqlite3 *db, /* Load the extension into this database connection */
|
|
const char *zFile, /* Name of the shared library containing extension */
|
|
const char *zProc, /* Entry point. Derived from zFile if 0 */
|
|
char **pzErrMsg /* Put error message here if not 0 */
|
|
);
|
|
</pre></blockquote>
|
|
<p>
|
|
This interface loads an SQLite extension library from the named file.</p>
|
|
|
|
<p>The sqlite3_load_extension() interface attempts to load an
|
|
<a href="../loadext.html">SQLite extension</a> library contained in the file zFile. If
|
|
the file cannot be loaded directly, attempts are made to load
|
|
with various operating-system specific extensions added.
|
|
So for example, if "samplelib" cannot be loaded, then names like
|
|
"samplelib.so" or "samplelib.dylib" or "samplelib.dll" might
|
|
be tried also.</p>
|
|
|
|
<p>The entry point is zProc.
|
|
zProc may be 0, in which case SQLite will try to come up with an
|
|
entry point name on its own. It first tries "sqlite3_extension_init".
|
|
If that does not work, it constructs a name "sqlite3_X_init" where the
|
|
X is consists of the lower-case equivalent of all ASCII alphabetic
|
|
characters in the filename from the last "/" to the first following
|
|
"." and omitting any initial "lib".
|
|
The sqlite3_load_extension() interface returns
|
|
<a href="../rescode.html#ok">SQLITE_OK</a> on success and <a href="../rescode.html#error">SQLITE_ERROR</a> if something goes wrong.
|
|
If an error occurs and pzErrMsg is not 0, then the
|
|
<a href="../c3ref/load_extension.html">sqlite3_load_extension()</a> interface shall attempt to
|
|
fill *pzErrMsg with error message text stored in memory
|
|
obtained from <a href="../c3ref/free.html">sqlite3_malloc()</a>. The calling function
|
|
should free this memory by calling <a href="../c3ref/free.html">sqlite3_free()</a>.</p>
|
|
|
|
<p>Extension loading must be enabled using
|
|
<a href="../c3ref/enable_load_extension.html">sqlite3_enable_load_extension()</a> or
|
|
<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)
|
|
prior to calling this API,
|
|
otherwise an error will be returned.</p>
|
|
|
|
<p><b>Security warning:</b> It is recommended that the
|
|
<a href="../c3ref/c_dbconfig_defensive.html#sqlitedbconfigenableloadextension">SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION</a> method be used to enable only this
|
|
interface. The use of the <a href="../c3ref/enable_load_extension.html">sqlite3_enable_load_extension()</a> interface
|
|
should be avoided. This will keep the SQL function <a href="../lang_corefunc.html#load_extension">load_extension()</a>
|
|
disabled and prevent SQL injections from giving attackers
|
|
access to extension loading capabilities.</p>
|
|
|
|
<p>See also the <a href="../lang_corefunc.html#load_extension">load_extension() SQL function</a>.
|
|
</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>
|