Debian Codegraph @

www/c3ref/blob_write.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>Write Data Into A BLOB Incrementally</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_blob_write -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Write Data Into A BLOB Incrementally</h2>
122 </div>
123 <blockquote><pre>
124 int sqlite3_blob_write(sqlite3_blob *, const void *z, int n, int iOffset);
125 </pre></blockquote>
126 <p>
127 This function is used to write data into an open <a href="../c3ref/blob.html">BLOB handle</a> from a
128 caller-supplied buffer. N bytes of data are copied from the buffer Z
129 into the open BLOB, starting at offset iOffset.</p>
130
131 <p>On success, sqlite3_blob_write() returns SQLITE_OK.
132 Otherwise, an <a href="../rescode.html">error code</a> or an <a href="../rescode.html#extrc">extended error code</a> is returned.
133 Unless SQLITE_MISUSE is returned, this function sets the
134 <a href="../c3ref/sqlite3.html">database connection</a> error code and message accessible via
135 <a href="../c3ref/errcode.html">sqlite3_errcode()</a> and <a href="../c3ref/errcode.html">sqlite3_errmsg()</a> and related functions.</p>
136
137 <p>If the <a href="../c3ref/blob.html">BLOB handle</a> passed as the first argument was not opened for
138 writing (the flags parameter to <a href="../c3ref/blob_open.html">sqlite3_blob_open()</a> was zero),
139 this function returns <a href="../rescode.html#readonly">SQLITE_READONLY</a>.</p>
140
141 <p>This function may only modify the contents of the BLOB; it is
142 not possible to increase the size of a BLOB using this API.
143 If offset iOffset is less than N bytes from the end of the BLOB,
144 <a href="../rescode.html#error">SQLITE_ERROR</a> is returned and no data is written. The size of the
145 BLOB (and hence the maximum value of N+iOffset) can be determined
146 using the <a href="../c3ref/blob_bytes.html">sqlite3_blob_bytes()</a> interface. If N or iOffset are less
147 than zero <a href="../rescode.html#error">SQLITE_ERROR</a> is returned and no data is written.</p>
148
149 <p>An attempt to write to an expired <a href="../c3ref/blob.html">BLOB handle</a> fails with an
150 error code of <a href="../rescode.html#abort">SQLITE_ABORT</a>. Writes to the BLOB that occurred
151 before the <a href="../c3ref/blob.html">BLOB handle</a> expired are not rolled back by the
152 expiration of the handle, though of course those changes might
153 have been overwritten by the statement that expired the BLOB handle
154 or by other independent statements.</p>
155
156 <p>This routine only works on a <a href="../c3ref/blob.html">BLOB handle</a> which has been created
157 by a prior successful call to <a href="../c3ref/blob_open.html">sqlite3_blob_open()</a> and which has not
158 been closed by <a href="../c3ref/blob_close.html">sqlite3_blob_close()</a>. Passing any other pointer in
159 to this routine results in undefined and probably undesirable behavior.</p>
160
161 <p>See also: <a href="../c3ref/blob_read.html">sqlite3_blob_read()</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