Debian Codegraph @

www/c3ref/aggregate_context.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>Obtain Aggregate Function Context</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_aggregate_context -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Obtain Aggregate Function Context</h2>
122 </div>
123 <blockquote><pre>
124 void *sqlite3_aggregate_context(sqlite3_context*, int nBytes);
125 </pre></blockquote>
126 <p>
127 Implementations of aggregate SQL functions use this
128 routine to allocate memory for storing their state.</p>
129
130 <p>The first time the sqlite3_aggregate_context(C,N) routine is called
131 for a particular aggregate function, SQLite allocates
132 N bytes of memory, zeroes out that memory, and returns a pointer
133 to the new memory. On second and subsequent calls to
134 sqlite3_aggregate_context() for the same aggregate function instance,
135 the same buffer is returned. Sqlite3_aggregate_context() is normally
136 called once for each invocation of the xStep callback and then one
137 last time when the xFinal callback is invoked. When no rows match
138 an aggregate query, the xStep() callback of the aggregate function
139 implementation is never called and xFinal() is called exactly once.
140 In those cases, sqlite3_aggregate_context() might be called for the
141 first time from within xFinal().</p>
142
143 <p>The sqlite3_aggregate_context(C,N) routine returns a NULL pointer
144 when first called if N is less than or equal to zero or if a memory
145 allocation error occurs.</p>
146
147 <p>The amount of space allocated by sqlite3_aggregate_context(C,N) is
148 determined by the N parameter on the first successful call. Changing the
149 value of N in any subsequent call to sqlite3_aggregate_context() within
150 the same aggregate function instance will not resize the memory
151 allocation. Within the xFinal callback, it is customary to set
152 N=0 in calls to sqlite3_aggregate_context(C,N) so that no
153 pointless memory allocations occur.</p>
154
155 <p>SQLite automatically frees the memory allocated by
156 sqlite3_aggregate_context() when the aggregate query concludes.</p>
157
158 <p>The first parameter must be a copy of the
159 <a href="../c3ref/context.html">SQL function context</a> that is the first parameter
160 to the xStep or xFinal callback routine that implements the aggregate
161 function.</p>
162
163 <p>This routine must be called from the same thread in which
164 the aggregate SQL function is running.
165 </p><p>See also lists of
166 <a href="../c3ref/objlist.html">Objects</a>,
167 <a href="../c3ref/constlist.html">Constants</a>, and
168 <a href="../c3ref/funclist.html">Functions</a>.</p>
169