/usr/share/gtk-doc/html/eds/EDataBookCursorSqlite.html is in evolution-data-server-doc 3.22.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EDataBookCursorSqlite: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch08.html" title="Addressbook Backend Classes">
<link rel="prev" href="EDataBookCursor.html" title="EDataBookCursor">
<link rel="next" href="EDataBookFactory.html" title="EDataBookFactory">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#EDataBookCursorSqlite.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EDataBookCursorSqlite.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch08.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EDataBookCursor.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EDataBookFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EDataBookCursorSqlite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EDataBookCursorSqlite.top_of_page"></a>EDataBookCursorSqlite</span></h2>
<p>EDataBookCursorSqlite — The SQLite cursor implementation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="EDataBookCursor.html" title="EDataBookCursor"><span class="returnvalue">EDataBookCursor</span></a> *
</td>
<td class="function_name">
<a class="link" href="EDataBookCursorSqlite.html#e-data-book-cursor-sqlite-new" title="e_data_book_cursor_sqlite_new ()">e_data_book_cursor_sqlite_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EDataBookCursorSqlite.html#EDataBookCursorSqlite-struct" title="struct EDataBookCursorSqlite">EDataBookCursorSqlite</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EDataBookCursorSqlite.html#EDataBookCursorSqliteClass" title="struct EDataBookCursorSqliteClass">EDataBookCursorSqliteClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a class="link" href="EDataBookCursor.html" title="EDataBookCursor">EDataBookCursor</a>
<span class="lineart">╰──</span> EDataBookCursorSqlite
</pre>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedata-book/libedata-book.h>
</pre>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.description"></a><h2>Description</h2>
<p>This cursor implementation can be used with any backend which
stores contacts using <a class="link" href="EBookSqlite.html" title="EBookSqlite"><span class="type">EBookSqlite</span></a>.</p>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-data-book-cursor-sqlite-new"></a><h3>e_data_book_cursor_sqlite_new ()</h3>
<pre class="programlisting"><a class="link" href="EDataBookCursor.html" title="EDataBookCursor"><span class="returnvalue">EDataBookCursor</span></a> *
e_data_book_cursor_sqlite_new (<em class="parameter"><code><a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> *backend</code></em>,
<em class="parameter"><code><a class="link" href="EBookSqlite.html" title="EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *revision_key</code></em>,
<em class="parameter"><code>const <a class="link" href="EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> *sort_fields</code></em>,
<em class="parameter"><code>const <a class="link" href="eds-e-book-contacts-types.html#EBookCursorSortType" title="enum EBookCursorSortType"><span class="type">EBookCursorSortType</span></a> *sort_types</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> n_fields</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates an <a class="link" href="EDataBookCursor.html" title="EDataBookCursor"><span class="type">EDataBookCursor</span></a> and implements all of the cursor methods
using the delegate <em class="parameter"><code>ebsql</code></em>
object.</p>
<p>This is a suitable cursor type for any backend which stores its contacts
using the <a class="link" href="EBookSqlite.html" title="EBookSqlite"><span class="type">EBookSqlite</span></a> object.</p>
<div class="refsect3">
<a name="e-data-book-cursor-sqlite-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>backend</p></td>
<td class="parameter_description"><p>the <a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> creating this cursor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ebsql</p></td>
<td class="parameter_description"><p>the <a class="link" href="EBookSqlite.html" title="EBookSqlite"><span class="type">EBookSqlite</span></a> object to base this cursor on</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>revision_key</p></td>
<td class="parameter_description"><p>The key name to consult for the current overall contacts database revision</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sort_fields</p></td>
<td class="parameter_description"><p> an array of <a href="EContact.html#EContactField"><span class="type">EContactFields</span></a> as sort keys in order of priority. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_fields]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>sort_types</p></td>
<td class="parameter_description"><p> an array of <a href="eds-e-book-contacts-types.html#EBookCursorSortType"><span class="type">EBookCursorSortTypes</span></a>, one for each field in <em class="parameter"><code>sort_fields</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_fields]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_fields</p></td>
<td class="parameter_description"><p>the number of fields to sort results by.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a return location to story any error that might be reported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-data-book-cursor-sqlite-new.returns"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="EDataBookCursor.html" title="EDataBookCursor"><span class="type">EDataBookCursor</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if cursor creation failed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
</div>
<div class="refsect1">
<a name="EDataBookCursorSqlite.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EDataBookCursorSqlite-struct"></a><h3>struct EDataBookCursorSqlite</h3>
<pre class="programlisting">struct EDataBookCursorSqlite;</pre>
<p>An opaque handle for the SQLite cursor instance.</p>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="EDataBookCursorSqliteClass"></a><h3>struct EDataBookCursorSqliteClass</h3>
<pre class="programlisting">struct EDataBookCursorSqliteClass {
EDataBookCursorClass parent;
};
</pre>
<p>The SQLite cursor class structure.</p>
<p class="since">Since: <a class="link" href="api-index-3.12.html" title="Index of new symbols in 3.12">3.12</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|