/usr/share/gtk-doc/html/eds/eds-EBookSqlite.html is in evolution-data-server-doc 3.18.5-1ubuntu1.
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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBookSqlite: 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="eds-EBookBackendSExp.html" title="EBookBackendSExp">
<link rel="next" href="eds-EDataBook.html" title="EDataBook">
<meta name="generator" content="GTK-Doc V1.24 (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="#eds-EBookSqlite.description" class="shortcut">Description</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="eds-EBookBackendSExp.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-EDataBook.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-EBookSqlite"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-EBookSqlite.top_of_page"></a>EBookSqlite</span></h2>
<p>EBookSqlite — An SQLite storage facility for addressbooks</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-EBookSqlite.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#E-BOOK-SQLITE-ERROR:CAPS" title="E_BOOK_SQLITE_ERROR">E_BOOK_SQLITE_ERROR</a></td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="eds-EBookSqlite.html#EbSqlChangeCallback" title="EbSqlChangeCallback ()">*EbSqlChangeCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="eds-EBookSqlite.html#EbSqlVCardCallback" title="EbSqlVCardCallback ()">*EbSqlVCardCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-error-quark" title="e_book_sqlite_error_quark ()">e_book_sqlite_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search-data-free" title="e_book_sqlite_search_data_free ()">e_book_sqlite_search_data_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="returnvalue">EBookSqlite</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new" title="e_book_sqlite_new ()">e_book_sqlite_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="returnvalue">EBookSqlite</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new-full" title="e_book_sqlite_new_full ()">e_book_sqlite_new_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-lock" title="e_book_sqlite_lock ()">e_book_sqlite_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()">e_book_sqlite_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-locale" title="e_book_sqlite_set_locale ()">e_book_sqlite_set_locale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-locale" title="e_book_sqlite_get_locale ()">e_book_sqlite_get_locale</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ECollator.html#ECollator" title="ECollator"><span class="returnvalue">ECollator</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-ref-collator" title="e_book_sqlite_ref_collator ()">e_book_sqlite_ref_collator</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-ref-source" title="e_book_sqlite_ref_source ()">e_book_sqlite_ref_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-add-contact" title="e_book_sqlite_add_contact ()">e_book_sqlite_add_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-add-contacts" title="e_book_sqlite_add_contacts ()">e_book_sqlite_add_contacts</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-remove-contact" title="e_book_sqlite_remove_contact ()">e_book_sqlite_remove_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-remove-contacts" title="e_book_sqlite_remove_contacts ()">e_book_sqlite_remove_contacts</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-has-contact" title="e_book_sqlite_has_contact ()">e_book_sqlite_has_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-contact" title="e_book_sqlite_get_contact ()">e_book_sqlite_get_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-vcard" title="e_book_sqlite_get_vcard ()">e_book_sqlite_get_vcard</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-contact-extra" title="e_book_sqlite_set_contact_extra ()">e_book_sqlite_set_contact_extra</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-contact-extra" title="e_book_sqlite_get_contact_extra ()">e_book_sqlite_get_contact_extra</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search" title="e_book_sqlite_search ()">e_book_sqlite_search</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search-uids" title="e_book_sqlite_search_uids ()">e_book_sqlite_search_uids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-key-value" title="e_book_sqlite_get_key_value ()">e_book_sqlite_get_key_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-key-value" title="e_book_sqlite_set_key_value ()">e_book_sqlite_set_key_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-key-value-int" title="e_book_sqlite_get_key_value_int ()">e_book_sqlite_get_key_value_int</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-key-value-int" title="e_book_sqlite_set_key_value_int ()">e_book_sqlite_set_key_value_int</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="returnvalue">EbSqlCursor</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-new" title="e_book_sqlite_cursor_new ()">e_book_sqlite_cursor_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-free" title="e_book_sqlite_cursor_free ()">e_book_sqlite_cursor_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-step" title="e_book_sqlite_cursor_step ()">e_book_sqlite_cursor_step</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-set-target-alphabetic-index" title="e_book_sqlite_cursor_set_target_alphabetic_index ()">e_book_sqlite_cursor_set_target_alphabetic_index</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-set-sexp" title="e_book_sqlite_cursor_set_sexp ()">e_book_sqlite_cursor_set_sexp</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-calculate" title="e_book_sqlite_cursor_calculate ()">e_book_sqlite_cursor_calculate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-compare-contact" title="e_book_sqlite_cursor_compare_contact ()">e_book_sqlite_cursor_compare_contact</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#ebsql-get-contact-extra-unlocked" title="ebsql_get_contact_extra_unlocked ()">ebsql_get_contact_extra_unlocked</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#ebsql-get-contact-unlocked" title="ebsql_get_contact_unlocked ()">ebsql_get_contact_unlocked</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-EBookSqlite.html#ebsql-get-vcard-unlocked" title="ebsql_get_vcard_unlocked ()">ebsql_get_vcard_unlocked</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EBookSqlite.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#E-BOOK-SQL-SYNC-DATA-KEY:CAPS" title="E_BOOK_SQL_SYNC_DATA_KEY">E_BOOK_SQL_SYNC_DATA_KEY</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlChangeType" title="enum EbSqlChangeType">EbSqlChangeType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EBookSqliteError" title="enum EBookSqliteError">EBookSqliteError</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlLockType" title="enum EbSqlLockType">EbSqlLockType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlUnlockAction" title="enum EbSqlUnlockAction">EbSqlUnlockAction</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlSearchData" title="EbSqlSearchData">EbSqlSearchData</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite">EBookSqlite</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EBookSqliteClass" title="struct EBookSqliteClass">EBookSqliteClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlCursorOrigin" title="enum EbSqlCursorOrigin">EbSqlCursorOrigin</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlCursorStepFlags" title="enum EbSqlCursorStepFlags">EbSqlCursorStepFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor">EbSqlCursor</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-EBookSqlite.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedata-book/libedata-book.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-EBookSqlite.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> is an API for storing and looking up <a href="eds-EContact.html#EContact"><span class="type">EContacts</span></a>
in an SQLite database. It also supports a lean index mode via
the <a class="link" href="eds-EBookSqlite.html#EbSqlVCardCallback" title="EbSqlVCardCallback ()"><span class="type">EbSqlVCardCallback</span></a>, if you are in a situation where it is
not convenient to store the vCards directly in the SQLite. It is
however recommended to avoid storing contacts in separate storage
if at all possible, as this will decrease performance of searches
an also contribute to flash wear.</p>
<p>The API is thread safe, with special considerations to be made
around <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-lock" title="e_book_sqlite_lock ()"><code class="function">e_book_sqlite_lock()</code></a> and <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()"><code class="function">e_book_sqlite_unlock()</code></a> for
the sake of isolating transactions across threads.</p>
<p>Any operations which can take a lot of time to complete (depending
on the size of your addressbook) can be cancelled using a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>.</p>
<p>Depending on your summary configuration, your mileage will vary. Refer
to the <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> for configuring your addressbook
for the type of usage you mean to make of it.</p>
</div>
<div class="refsect1">
<a name="eds-EBookSqlite.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="E-BOOK-SQLITE-ERROR:CAPS"></a><h3>E_BOOK_SQLITE_ERROR</h3>
<pre class="programlisting">#define E_BOOK_SQLITE_ERROR (e_book_sqlite_error_quark ())
</pre>
<p>Error domain for <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> operations.</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="EbSqlChangeCallback"></a><h3>EbSqlChangeCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*EbSqlChangeCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlChangeType" title="enum EbSqlChangeType"><span class="type">EbSqlChangeType</span></a> change_type</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> *uid</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> *extra</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> *vcard</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>A function which may be called in response to a change
in contact data.</p>
<div class="note"><p>This user callback is called inside a lock,
you must not call the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> API from
this callback.</p></div>
<div class="refsect3">
<a name="id-1.4.4.5.7.3.6"></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>change_type</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlChangeType" title="enum EbSqlChangeType"><span class="type">EbSqlChangeType</span></a> which occurred</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>A contact UID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extra</p></td>
<td class="parameter_description"><p>The extra data associated to the contact</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vcard</p></td>
<td class="parameter_description"><p>The vcard string for this UID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Pointer to user provided data</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="EbSqlVCardCallback"></a><h3>EbSqlVCardCallback ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
<span class="c_punctuation">(</span>*EbSqlVCardCallback<span class="c_punctuation">)</span> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</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> *extra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>If this callback is passed to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new" title="e_book_sqlite_new ()"><code class="function">e_book_sqlite_new()</code></a>, then
vcards are not stored in the SQLite and instead this callback
is invoked to fetch the vcard.</p>
<p>This callback will be called to fetch results for fully indexed
and optimized queries, and it will also be called while performing
fallback queries against <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> which are not configured
in the <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> or default summary fields. </p>
<div class="note"><p>This user callback is called inside a lock,
you must not call the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> API from
this callback.</p></div>
<div class="refsect3">
<a name="id-1.4.4.5.7.4.7"></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>uid</p></td>
<td class="parameter_description"><p>A contact UID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extra</p></td>
<td class="parameter_description"><p>The extra data associated to the contact</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>User data previously passed to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new" title="e_book_sqlite_new ()"><code class="function">e_book_sqlite_new()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.4.8"></a><h4>Returns</h4>
<p> The appropriate vcard indicated by <em class="parameter"><code>uid</code></em>
. </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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-error-quark"></a><h3>e_book_sqlite_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
e_book_sqlite_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-search-data-free"></a><h3>e_book_sqlite_search_data_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_sqlite_search_data_free (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlSearchData" title="EbSqlSearchData"><span class="type">EbSqlSearchData</span></a> *data</code></em>);</pre>
<p>Frees an <a class="link" href="eds-EBookSqlite.html#EbSqlSearchData" title="EbSqlSearchData"><span class="type">EbSqlSearchData</span></a></p>
<div class="refsect3">
<a name="id-1.4.4.5.7.6.5"></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>data</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EbSqlSearchData" title="EbSqlSearchData"><span class="type">EbSqlSearchData</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-new"></a><h3>e_book_sqlite_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="returnvalue">EBookSqlite</span></a> *
e_book_sqlite_new (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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 a new <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> with the default summary configuration.</p>
<p>Aside from the manditory fields <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a>,
the default configuration stores the following fields for quick
performance of searches: <a class="link" href="eds-EContact.html#E-CONTACT-FILE-AS:CAPS"><code class="literal">E_CONTACT_FILE_AS</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-NICKNAME:CAPS"><code class="literal">E_CONTACT_NICKNAME</code></a>,
<a class="link" href="eds-EContact.html#E-CONTACT-FULL-NAME:CAPS"><code class="literal">E_CONTACT_FULL_NAME</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-GIVEN-NAME:CAPS"><code class="literal">E_CONTACT_GIVEN_NAME</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-FAMILY-NAME:CAPS"><code class="literal">E_CONTACT_FAMILY_NAME</code></a>,
<a class="link" href="eds-EContact.html#E-CONTACT-EMAIL:CAPS"><code class="literal">E_CONTACT_EMAIL</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-TEL:CAPS"><code class="literal">E_CONTACT_TEL</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-IS-LIST:CAPS"><code class="literal">E_CONTACT_IS_LIST</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-LIST-SHOW-ADDRESSES:CAPS"><code class="literal">E_CONTACT_LIST_SHOW_ADDRESSES</code></a>,
and <a class="link" href="eds-EContact.html#E-CONTACT-WANTS-HTML:CAPS"><code class="literal">E_CONTACT_WANTS_HTML</code></a>.</p>
<p>The fields <a class="link" href="eds-EContact.html#E-CONTACT-FULL-NAME:CAPS"><code class="literal">E_CONTACT_FULL_NAME</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-EMAIL:CAPS"><code class="literal">E_CONTACT_EMAIL</code></a> are configured
to respond extra quickly with the <a class="link" href="eds-Addressbook-related-types.html#E-BOOK-INDEX-PREFIX:CAPS"><code class="literal">E_BOOK_INDEX_PREFIX</code></a> index flag.</p>
<p>The fields <a class="link" href="eds-EContact.html#E-CONTACT-FILE-AS:CAPS"><code class="literal">E_CONTACT_FILE_AS</code></a>, <a class="link" href="eds-EContact.html#E-CONTACT-FAMILY-NAME:CAPS"><code class="literal">E_CONTACT_FAMILY_NAME</code></a> and
<a class="link" href="eds-EContact.html#E-CONTACT-GIVEN-NAME:CAPS"><code class="literal">E_CONTACT_GIVEN_NAME</code></a> are configured to perform well with
the <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> interface, using the <a class="link" href="eds-Addressbook-related-types.html#E-BOOK-INDEX-SORT-KEY:CAPS"><code class="literal">E_BOOK_INDEX_SORT_KEY</code></a>
index flag.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.7.8"></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>path</p></td>
<td class="parameter_description"><p>location to load or create the new database</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an optional <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, associated with the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.7.9"></a><h4>Returns</h4>
<p> A reference to a <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a>. </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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-new-full"></a><h3>e_book_sqlite_new_full ()</h3>
<pre class="programlisting"><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="returnvalue">EBookSqlite</span></a> *
e_book_sqlite_new_full (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>,
<em class="parameter"><code><a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> *setup</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlVCardCallback" title="EbSqlVCardCallback ()"><span class="type">EbSqlVCardCallback</span></a> vcard_callback</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlChangeCallback" title="EbSqlChangeCallback ()"><span class="type">EbSqlChangeCallback</span></a> change_callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> user_data_destroy</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Opens or creates a new addressbook at <em class="parameter"><code>path</code></em>
.</p>
<p>Like <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new" title="e_book_sqlite_new ()"><code class="function">e_book_sqlite_new()</code></a>, but allows configuration of which contact fields
will be stored for quick reference in the summary. The configuration indicated by
<em class="parameter"><code>setup</code></em>
will only be taken into account when initially creating the underlying table,
further configurations will be ignored.</p>
<p>The fields <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> are not optional,
they will be stored in the summary regardless of this function's parameters.
Only <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> with the type <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-STRING:CAPS"><span class="type">G_TYPE_STRING</span></a>, <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-BOOLEAN:CAPS"><span class="type">G_TYPE_BOOLEAN</span></a> or
<span class="type">E_TYPE_CONTACT_ATTR_LIST</span> are currently supported.</p>
<p>If <em class="parameter"><code>vcard_callback</code></em>
is specified, then vcards will not be stored by functions
such as <code class="function">e_book_sqlitedb_add_contact()</code>. Instead <em class="parameter"><code>vcard_callback</code></em>
will be invoked
at any time the created <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> requires a vcard, either as a fallback
for querying search expressions which cannot be satisfied with the summary
fields, or when reporting results from searches.</p>
<p>If any error occurs and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned, then the passed <em class="parameter"><code>user_data</code></em>
will
be automatically freed using the <em class="parameter"><code>user_data_destroy</code></em>
function, if specified.</p>
<p>It is recommended to store all contact vcards in the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> addressbook
if at all possible, however in some cases the vcards must be stored in some
other storage.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.8.10"></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>path</p></td>
<td class="parameter_description"><p>location to load or create the new database</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an optional <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>, associated with the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>setup</p></td>
<td class="parameter_description"><p> an <a class="link" href="eds-ESourceBackendSummarySetup.html#ESourceBackendSummarySetup" title="struct ESourceBackendSummarySetup"><span class="type">ESourceBackendSummarySetup</span></a> describing how the summary should be setup, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>vcard_callback</p></td>
<td class="parameter_description"><p> A function to resolve vcards. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>change_callback</p></td>
<td class="parameter_description"><p> A function to catch notifications of vcard changes. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> callback user data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data_destroy</p></td>
<td class="parameter_description"><p> A function to free <em class="parameter"><code>user_data</code></em>
automatically when the created <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> is destroyed. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.8.11"></a><h4>Returns</h4>
<p> The newly created <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if opening or creating the addressbook 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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-lock"></a><h3>e_book_sqlite_lock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_lock (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlLockType" title="enum EbSqlLockType"><span class="type">EbSqlLockType</span></a> lock_type</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Obtains an exclusive lock on <em class="parameter"><code>ebsql</code></em>
and starts a transaction.</p>
<p>This should be called if you need to access <em class="parameter"><code>ebsql</code></em>
multiple times while
ensuring an atomic transaction. End this transaction with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()"><code class="function">e_book_sqlite_unlock()</code></a>.</p>
<p>If <em class="parameter"><code>cancellable</code></em>
is specified, then <em class="parameter"><code>ebsql</code></em>
will retain a reference to it until
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()"><code class="function">e_book_sqlite_unlock()</code></a> is called. Any accesses to <em class="parameter"><code>ebsql</code></em>
with the lock held
are expected to have the same <em class="parameter"><code>cancellable</code></em>
specified, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="note"><p>Aside from ensuring atomicity of transactions, this function will hold a mutex
which will cause further calls to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-lock" title="e_book_sqlite_lock ()"><code class="function">e_book_sqlite_lock()</code></a> to block. If you are accessing
<em class="parameter"><code>ebsql</code></em> from multiple threads, then any interactions with <em class="parameter"><code>ebsql</code></em> should be nested in calls
to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-lock" title="e_book_sqlite_lock ()"><code class="function">e_book_sqlite_lock()</code></a> and <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()"><code class="function">e_book_sqlite_unlock()</code></a>.</p></div>
<div class="refsect3">
<a name="id-1.4.4.5.7.9.8"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lock_type</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlLockType" title="enum EbSqlLockType"><span class="type">EbSqlLockType</span></a> to acquire</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.9.9"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-unlock"></a><h3>e_book_sqlite_unlock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_unlock (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlUnlockAction" title="enum EbSqlUnlockAction"><span class="type">EbSqlUnlockAction</span></a> action</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>Releases an exclusive on <em class="parameter"><code>ebsql</code></em>
and finishes a transaction previously
started with <code class="function">e_book_sqlite_lock_updates()</code>.</p>
<div class="note"><p>If this fails, the lock on <em class="parameter"><code>ebsql</code></em> is still released and <em class="parameter"><code>error</code></em> will
be set to indicate why the transaction or rollback failed.</p></div>
<div class="refsect3">
<a name="id-1.4.4.5.7.10.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>action</p></td>
<td class="parameter_description"><p>Which <a class="link" href="eds-EBookSqlite.html#EbSqlUnlockAction" title="enum EbSqlUnlockAction"><span class="type">EbSqlUnlockAction</span></a> to take while unlocking</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.10.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-set-locale"></a><h3>e_book_sqlite_set_locale ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_set_locale (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *lc_collate</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Relocalizes any locale specific data in the specified
new <em class="parameter"><code>lc_collate</code></em>
locale.</p>
<p>The <em class="parameter"><code>lc_collate</code></em>
locale setting is stored and remembered on
subsequent accesses of the addressbook, changing the locale
will store the new locale and will modify sort keys and any
locale specific data in the addressbook.</p>
<p>As a side effect, it's possible that changing the locale
will cause stored vcards to change. Notifications for
these changes can be caught with the <a class="link" href="eds-EBookSqlite.html#EbSqlVCardCallback" title="EbSqlVCardCallback ()"><span class="type">EbSqlVCardCallback</span></a>
provided to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new-full" title="e_book_sqlite_new_full ()"><code class="function">e_book_sqlite_new_full()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.11.7"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>lc_collate</p></td>
<td class="parameter_description"><p>The new locale for the addressbook</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A location to store any error that may have occurred</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.11.8"></a><h4>Returns</h4>
<p> Whether the new locale was successfully set.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-locale"></a><h3>e_book_sqlite_get_locale ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_locale (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **locale_out</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>Fetches the current locale setting for the address-book.</p>
<p>Upon success, <em class="parameter"><code>lc_collate_out</code></em>
will hold the returned locale setting,
otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will be returned and <em class="parameter"><code>error</code></em>
will be updated accordingly.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.12.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>locale_out</p></td>
<td class="parameter_description"><p> The location to return the current locale. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A location to store any error that may have occurred</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.12.7"></a><h4>Returns</h4>
<p> Whether the locale was successfully fetched.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-ref-collator"></a><h3>e_book_sqlite_ref_collator ()</h3>
<pre class="programlisting"><a class="link" href="eds-ECollator.html#ECollator" title="ECollator"><span class="returnvalue">ECollator</span></a> *
e_book_sqlite_ref_collator (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>);</pre>
<p>References the currently active <a class="link" href="eds-ECollator.html#ECollator" title="ECollator"><span class="type">ECollator</span></a> for <em class="parameter"><code>ebsql</code></em>
,
use <a class="link" href="eds-ECollator.html#e-collator-unref" title="e_collator_unref ()"><code class="function">e_collator_unref()</code></a> when finished using the returned collator.</p>
<p>Note that the active collator will change with the active locale setting.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.13.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.13.7"></a><h4>Returns</h4>
<p> A reference to the active collator. </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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-ref-source"></a><h3>e_book_sqlite_ref_source ()</h3>
<pre class="programlisting"><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *
e_book_sqlite_ref_source (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>);</pre>
<p>References the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>ebsql</code></em>
is paired,
use <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished using the source.
It can be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in some cases, like when running tests.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.14.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.14.6"></a><h4>Returns</h4>
<p> A reference to the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>ebsql</code></em>
is paired, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </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: 3.16</p>
</div>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-add-contact"></a><h3>e_book_sqlite_add_contact ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_add_contact (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> *contact</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> *extra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> replace</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>
</div>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-add-contacts"></a><h3>e_book_sqlite_add_contacts ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_add_contacts (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *contacts</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *extra</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> replace</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>
</div>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-remove-contact"></a><h3>e_book_sqlite_remove_contact ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_remove_contact (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Removes the contact indicated by <em class="parameter"><code>uid</code></em>
from <em class="parameter"><code>ebsql</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.17.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>the uid of the contact to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.17.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-remove-contacts"></a><h3>e_book_sqlite_remove_contacts ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_remove_contacts (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *uids</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Removes the contacts indicated by <em class="parameter"><code>uids</code></em>
from <em class="parameter"><code>ebsql</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.18.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uids</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of uids indicating which contacts to remove</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.18.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-has-contact"></a><h3>e_book_sqlite_has_contact ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_has_contact (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *exists</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>Checks if a contact bearing the UID indicated by <em class="parameter"><code>uid</code></em>
is stored in <em class="parameter"><code>ebsql</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.19.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to check for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>exists</p></td>
<td class="parameter_description"><p> Return location to store whether the contact exists. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.19.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-contact"></a><h3>e_book_sqlite_get_contact ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_contact (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> meta_contact</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> **ret_contact</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>Fetch the <a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> specified by <em class="parameter"><code>uid</code></em>
in <em class="parameter"><code>ebsql</code></em>
.</p>
<p>If <em class="parameter"><code>meta_contact</code></em>
is specified, then a shallow <a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> will be created
holding only the <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> fields.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.20.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>meta_contact</p></td>
<td class="parameter_description"><p>Whether an entire contact is desired, or only the metadata</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_contact</p></td>
<td class="parameter_description"><p> Return location to store the fetched contact. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.20.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-vcard"></a><h3>e_book_sqlite_get_vcard ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_vcard (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> meta_contact</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ret_vcard</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>Fetch a vcard string for <em class="parameter"><code>uid</code></em>
in <em class="parameter"><code>ebsql</code></em>
.</p>
<p>If <em class="parameter"><code>meta_contact</code></em>
is specified, then a shallow vcard representation will be
created holding only the <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> fields.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.21.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>meta_contact</p></td>
<td class="parameter_description"><p>Whether an entire contact is desired, or only the metadata</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_vcard</p></td>
<td class="parameter_description"><p> Return location to store the fetched vcard string. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.21.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-set-contact-extra"></a><h3>e_book_sqlite_set_contact_extra ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_set_contact_extra (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</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> *extra</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>Sets or replaces the extra data associated with <em class="parameter"><code>uid</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.22.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to set the extra data for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>extra</p></td>
<td class="parameter_description"><p> The extra data to set. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.22.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-contact-extra"></a><h3>e_book_sqlite_get_contact_extra ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_contact_extra (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ret_extra</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>Fetches the extra data previously set for <em class="parameter"><code>uid</code></em>
, either with
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-contact-extra" title="e_book_sqlite_set_contact_extra ()"><code class="function">e_book_sqlite_set_contact_extra()</code></a> or when adding contacts.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.23.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch the extra data for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_extra</p></td>
<td class="parameter_description"><p> Return location to store the extra data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.23.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-search"></a><h3>e_book_sqlite_search ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_search (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *sexp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> meta_contacts</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **ret_list</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Searches <em class="parameter"><code>ebsql</code></em>
for contacts matching the search expression indicated by <em class="parameter"><code>sexp</code></em>
.</p>
<p>When <em class="parameter"><code>sexp</code></em>
refers only to <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a> configured in the summary of <em class="parameter"><code>ebsql</code></em>
,
the search should always be quick, when searching for other <a href="eds-EContact.html#EContactField"><span class="type">EContactFields</span></a>
a fallback will be used, possibly invoking any <a class="link" href="eds-EBookSqlite.html#EbSqlVCardCallback" title="EbSqlVCardCallback ()"><span class="type">EbSqlVCardCallback</span></a> which
may have been passed to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-new-full" title="e_book_sqlite_new_full ()"><code class="function">e_book_sqlite_new_full()</code></a>.</p>
<p>The returned <em class="parameter"><code>ret_list</code></em>
list should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>
and all elements freed with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search-data-free" title="e_book_sqlite_search_data_free ()"><code class="function">e_book_sqlite_search_data_free()</code></a>.</p>
<p>If <em class="parameter"><code>meta_contact</code></em>
is specified, then shallow vcard representations will be
created holding only the <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> fields.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.24.8"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sexp</p></td>
<td class="parameter_description"><p> search expression; use <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or an empty string to list all stored contacts. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>meta_contacts</p></td>
<td class="parameter_description"><p>Whether entire contacts are desired, or only the metadata</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_list</p></td>
<td class="parameter_description"><p> Return location
to store a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of <a class="link" href="eds-EBookSqlite.html#EbSqlSearchData" title="EbSqlSearchData"><span class="type">EbSqlSearchData</span></a> structures. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> EbSqlSearchData]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.24.9"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-search-uids"></a><h3>e_book_sqlite_search_uids ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_search_uids (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *sexp</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **ret_list</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Similar to <code class="function">e_book_sqlitedb_search()</code>, but fetches only a list of contact UIDs.</p>
<p>The returned <em class="parameter"><code>ret_list</code></em>
list should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a> and all
elements freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.25.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sexp</p></td>
<td class="parameter_description"><p> search expression; use <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or an empty string to get all stored contacts. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>ret_list</p></td>
<td class="parameter_description"><p> Return location to store a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of contact uids. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.25.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-key-value"></a><h3>e_book_sqlite_get_key_value ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_key_value (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *key</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</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>Fetches the value for <em class="parameter"><code>key</code></em>
and stores it in <em class="parameter"><code>value</code></em>
</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.26.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to fetch a value for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> A return location to store the value for <em class="parameter"><code>key</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.26.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-set-key-value"></a><h3>e_book_sqlite_set_key_value ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_set_key_value (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *key</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> *value</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>Sets the value for <em class="parameter"><code>key</code></em>
to be <em class="parameter"><code>value</code></em>
</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.27.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to fetch a value for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The new value for <em class="parameter"><code>key</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.27.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-get-key-value-int"></a><h3>e_book_sqlite_get_key_value_int ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_get_key_value_int (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *key</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *value</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>A convenience function to fetch the value of <em class="parameter"><code>key</code></em>
as an integer.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.28.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to fetch a value for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> A return location to store the value for <em class="parameter"><code>key</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.28.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-set-key-value-int"></a><h3>e_book_sqlite_set_key_value_int ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_set_key_value_int (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *key</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> value</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>A convenience function to set the value of <em class="parameter"><code>key</code></em>
as an integer.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.29.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The key to fetch a value for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The new value for <em class="parameter"><code>key</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.29.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-new"></a><h3>e_book_sqlite_cursor_new ()</h3>
<pre class="programlisting"><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="returnvalue">EbSqlCursor</span></a> *
e_book_sqlite_cursor_new (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *sexp</code></em>,
<em class="parameter"><code>const <a class="link" href="eds-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-Addressbook-related-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_sort_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 a new <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a>.</p>
<p>The cursor should be freed with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-free" title="e_book_sqlite_cursor_free ()"><code class="function">e_book_sqlite_cursor_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.30.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sexp</p></td>
<td class="parameter_description"><p>search expression; use NULL or an empty string to get all stored contacts.</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="eds-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_sort_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-Addressbook-related-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_sort_fields]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>n_sort_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 store any error that might be reported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.30.7"></a><h4>Returns</h4>
<p> A newly created <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a>. </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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-free"></a><h3>e_book_sqlite_cursor_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_sqlite_cursor_free (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</code></em>);</pre>
<p>Frees <em class="parameter"><code>cursor</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.31.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> to free</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-step"></a><h3>e_book_sqlite_cursor_step ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_book_sqlite_cursor_step (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursorStepFlags" title="enum EbSqlCursorStepFlags"><span class="type">EbSqlCursorStepFlags</span></a> flags</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursorOrigin" title="enum EbSqlCursorOrigin"><span class="type">EbSqlCursorOrigin</span></a> origin</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> count</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **results</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Steps <em class="parameter"><code>cursor</code></em>
through it's sorted query by a maximum of <em class="parameter"><code>count</code></em>
contacts
starting from <em class="parameter"><code>origin</code></em>
.</p>
<p>If <em class="parameter"><code>count</code></em>
is negative, then the cursor will move through the list in reverse.</p>
<p>If <em class="parameter"><code>cursor</code></em>
reaches the beginning or end of the query results, then the
returned list might not contain the amount of desired contacts, or might
return no results if the cursor currently points to the last contact.
Reaching the end of the list is not considered an error condition. Attempts
to step beyond the end of the list after having reached the end of the list
will however trigger an <a class="link" href="eds-EBookSqlite.html#E-BOOK-SQLITE-ERROR-END-OF-LIST:CAPS"><code class="literal">E_BOOK_SQLITE_ERROR_END_OF_LIST</code></a> error.</p>
<p>If <a class="link" href="eds-EBookSqlite.html#EBSQL-CURSOR-STEP-FETCH:CAPS"><code class="literal">EBSQL_CURSOR_STEP_FETCH</code></a> is specified in <code class="literal">flags</code>, a pointer to
a <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> pointer should be provided for the <em class="parameter"><code>results</code></em>
parameter.</p>
<p>The result list will be stored to <em class="parameter"><code>results</code></em>
and should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#g-slist-free"><code class="function">g_slist_free()</code></a>
and all elements freed with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search-data-free" title="e_book_sqlite_search_data_free ()"><code class="function">e_book_sqlite_search_data_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.32.9"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> to use</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursorStepFlags" title="enum EbSqlCursorStepFlags"><span class="type">EbSqlCursorStepFlags</span></a> for this step</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>origin</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursorOrigin" title="enum EbSqlCursorOrigin"><span class="type">EbSqlCursorOrigin</span></a> from whence to step</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>count</p></td>
<td class="parameter_description"><p>A positive or negative amount of contacts to try and fetch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>results</p></td>
<td class="parameter_description"><p> A return location to store the results, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <a class="link" href="eds-EBookSqlite.html#EBSQL-CURSOR-STEP-FETCH:CAPS"><code class="literal">EBSQL_CURSOR_STEP_FETCH</code></a> is not specified in <code class="literal">flags</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> EbSqlSearchData][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>A return location to store any error that might be reported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.32.10"></a><h4>Returns</h4>
<p> The number of contacts traversed if successful, otherwise -1 is
returned and <em class="parameter"><code>error</code></em>
is set.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-set-target-alphabetic-index"></a><h3>e_book_sqlite_cursor_set_target_alphabetic_index ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_book_sqlite_cursor_set_target_alphabetic_index
(<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> idx</code></em>);</pre>
<p>Sets the <em class="parameter"><code>cursor</code></em>
position to an</p>
<a class="link" href="eds-EBookClientCursor.html#cursor-alphabet" title="Alphabetic Indexes">Alphabetic Index</a><p>into the alphabet active in <em class="parameter"><code>ebsql</code></em>
's locale.</p>
<p>After setting the target to an alphabetic index, for example the
index for letter 'E', then further calls to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-step" title="e_book_sqlite_cursor_step ()"><code class="function">e_book_sqlite_cursor_step()</code></a>
will return results starting with the letter 'E' (or results starting
with the last result in 'D', if moving in a negative direction).</p>
<p>The passed index must be a valid index in the active locale, knowledge
on the currently active alphabet index must be obtained using <a class="link" href="eds-ECollator.html#ECollator" title="ECollator"><span class="type">ECollator</span></a>
APIs.</p>
<p>Use <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-ref-collator" title="e_book_sqlite_ref_collator ()"><code class="function">e_book_sqlite_ref_collator()</code></a> to obtain the active collator for <em class="parameter"><code>ebsql</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.33.10"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> to modify</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>idx</p></td>
<td class="parameter_description"><p>The alphabetic index</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-set-sexp"></a><h3>e_book_sqlite_cursor_set_sexp ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_cursor_set_sexp (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</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> *sexp</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>Modifies the current query expression for <em class="parameter"><code>cursor</code></em>
. This will not
modify <em class="parameter"><code>cursor</code></em>
's state, but will change the outcome of any further
calls to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-calculate" title="e_book_sqlite_cursor_calculate ()"><code class="function">e_book_sqlite_cursor_calculate()</code></a> or
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-step" title="e_book_sqlite_cursor_step ()"><code class="function">e_book_sqlite_cursor_step()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.34.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sexp</p></td>
<td class="parameter_description"><p>The new query expression for <em class="parameter"><code>cursor</code></em>
</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 store any error that might be reported.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.34.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the expression was valid and accepted by <em class="parameter"><code>ebsql</code></em>
</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-calculate"></a><h3>e_book_sqlite_cursor_calculate ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_book_sqlite_cursor_calculate (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *total</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *position</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</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>Calculates the <em class="parameter"><code>total</code></em>
amount of results for the <em class="parameter"><code>cursor</code></em>
's query expression,
as well as the current <em class="parameter"><code>position</code></em>
of <em class="parameter"><code>cursor</code></em>
in the results. <em class="parameter"><code>position</code></em>
is
represented as the amount of results which lead up to the current value
of <em class="parameter"><code>cursor</code></em>
, if <em class="parameter"><code>cursor</code></em>
currently points to an exact contact, the position
also includes the cursor contact.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.35.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>total</p></td>
<td class="parameter_description"><p> A return location to store the total result set for this cursor. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p> A return location to store the total results before the cursor value. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A return location to store any error that might be reported. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.35.6"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>total</code></em>
and <em class="parameter"><code>position</code></em>
were successfully calculated.</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>
<hr>
<div class="refsect2">
<a name="e-book-sqlite-cursor-compare-contact"></a><h3>e_book_sqlite_cursor_compare_contact ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
e_book_sqlite_cursor_compare_contact (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> *ebsql</code></em>,
<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a> *cursor</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> *contact</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *matches_sexp</code></em>);</pre>
<p>Compares <em class="parameter"><code>contact</code></em>
with <em class="parameter"><code>cursor</code></em>
and returns whether <em class="parameter"><code>contact</code></em>
is less than, equal to, or greater
than <em class="parameter"><code>cursor</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.36.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EBookSqlite.html#EbSqlCursor" title="EbSqlCursor"><span class="type">EbSqlCursor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>contact</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> to compare</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>matches_sexp</p></td>
<td class="parameter_description"><p> Whether the contact matches the cursor's search expression. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.36.6"></a><h4>Returns</h4>
<p> A value that is less than, equal to, or greater than zero if <em class="parameter"><code>contact</code></em>
is found,
respectively, to be less than, to match, or be greater than the current value of <em class="parameter"><code>cursor</code></em>
.</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>
<hr>
<div class="refsect2">
<a name="ebsql-get-contact-extra-unlocked"></a><h3>ebsql_get_contact_extra_unlocked ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ebsql_get_contact_extra_unlocked (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ret_extra</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>Fetches the extra data previously set for <em class="parameter"><code>uid</code></em>
, either with
<a class="link" href="eds-EBookSqlite.html#e-book-sqlite-set-contact-extra" title="e_book_sqlite_set_contact_extra ()"><code class="function">e_book_sqlite_set_contact_extra()</code></a> or when adding contacts,
without locking internal mutex.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.37.5"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch the extra data for</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_extra</p></td>
<td class="parameter_description"><p> Return location to store the extra data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.37.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</p>
</div>
<p class="since">Since: 3.16</p>
</div>
<hr>
<div class="refsect2">
<a name="ebsql-get-contact-unlocked"></a><h3>ebsql_get_contact_unlocked ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ebsql_get_contact_unlocked (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> meta_contact</code></em>,
<em class="parameter"><code><a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> **ret_contact</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>Fetch the <a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> specified by <em class="parameter"><code>uid</code></em>
in <em class="parameter"><code>ebsql</code></em>
without locking internal mutex.</p>
<p>If <em class="parameter"><code>meta_contact</code></em>
is specified, then a shallow <a class="link" href="eds-EContact.html#EContact" title="struct EContact"><span class="type">EContact</span></a> will be created
holding only the <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> fields.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.38.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>meta_contact</p></td>
<td class="parameter_description"><p>Whether an entire contact is desired, or only the metadata</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>contact</p></td>
<td class="parameter_description"><p> Return location to store the fetched contact. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.38.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</p>
</div>
<p class="since">Since: 3.16</p>
</div>
<hr>
<div class="refsect2">
<a name="ebsql-get-vcard-unlocked"></a><h3>ebsql_get_vcard_unlocked ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
ebsql_get_vcard_unlocked (<em class="parameter"><code><a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct 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> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> meta_contact</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **ret_vcard</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>Fetch a vcard string for <em class="parameter"><code>uid</code></em>
in <em class="parameter"><code>ebsql</code></em>
without locking internal mutex.</p>
<p>If <em class="parameter"><code>meta_contact</code></em>
is specified, then a shallow vcard representation will be
created holding only the <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> and <a class="link" href="eds-EContact.html#E-CONTACT-REV:CAPS"><code class="literal">E_CONTACT_REV</code></a> fields.</p>
<div class="refsect3">
<a name="id-1.4.4.5.7.39.6"></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>ebsql</p></td>
<td class="parameter_description"><p>An <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>The uid of the contact to fetch</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>meta_contact</p></td>
<td class="parameter_description"><p>Whether an entire contact is desired, or only the metadata</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ret_vcard</p></td>
<td class="parameter_description"><p> Return location to store the fetched vcard string. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> A location to store any error that may have occurred. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.4.5.7.39.7"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, otherwise <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and <em class="parameter"><code>error</code></em>
is set appropriately.</p>
</div>
<p class="since">Since: 3.16</p>
</div>
</div>
<div class="refsect1">
<a name="eds-EBookSqlite.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-BOOK-SQL-SYNC-DATA-KEY:CAPS"></a><h3>E_BOOK_SQL_SYNC_DATA_KEY</h3>
<pre class="programlisting">#define E_BOOK_SQL_SYNC_DATA_KEY "eds-reserved-namespace-sync-data"
</pre>
<p>This key can be used with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-get-key-value" title="e_book_sqlite_get_key_value ()"><code class="function">e_book_sqlite_get_key_value()</code></a>.</p>
<p>In the case of a migration from an older SQLite, any value which
was previously stored with <code class="function">e_book_sqlitedb_set_sync_data()</code>
can be retrieved with this key.</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="EbSqlChangeType"></a><h3>enum EbSqlChangeType</h3>
<p>Indicates the type of change which occurred in a <a class="link" href="eds-EBookSqlite.html#EbSqlChangeCallback" title="EbSqlChangeCallback ()"><span class="type">EbSqlChangeCallback</span></a></p>
<div class="refsect3">
<a name="id-1.4.4.5.8.3.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CHANGE-CONTACT-ADDED:CAPS"></a>EBSQL_CHANGE_CONTACT_ADDED</p></td>
<td class="enum_member_description">
<p>Contact was modified as a result of it's addition to the addressbook</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CHANGE-LOCALE-CHANGED:CAPS"></a>EBSQL_CHANGE_LOCALE_CHANGED</p></td>
<td class="enum_member_description">
<p>Contact was modified as a result of a locale change</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CHANGE-LAST:CAPS"></a>EBSQL_CHANGE_LAST</p></td>
<td class="enum_member_description">
<p>A symbolic end marker for this enumeration, will not be passed in callbacks.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="EBookSqliteError"></a><h3>enum EBookSqliteError</h3>
<p>Defines the types of possible errors reported by the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a></p>
<div class="refsect3">
<a name="id-1.4.4.5.8.4.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-ENGINE:CAPS"></a>E_BOOK_SQLITE_ERROR_ENGINE</p></td>
<td class="enum_member_description">
<p>An error was reported from the SQLite engine</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-CONSTRAINT:CAPS"></a>E_BOOK_SQLITE_ERROR_CONSTRAINT</p></td>
<td class="enum_member_description">
<p>The error occurred due to an explicit constraint, this will
happen when attempting to add two contacts with the same UID.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-CONTACT-NOT-FOUND:CAPS"></a>E_BOOK_SQLITE_ERROR_CONTACT_NOT_FOUND</p></td>
<td class="enum_member_description">
<p>A contact was not found by UID (this is
different from a query that returns no results, which is not an error).</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-INVALID-QUERY:CAPS"></a>E_BOOK_SQLITE_ERROR_INVALID_QUERY</p></td>
<td class="enum_member_description">
<p>A query was invalid. This can happen if the
search expression could not be parsed or if a phone number query contained non-phonenumber input.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-UNSUPPORTED-QUERY:CAPS"></a>E_BOOK_SQLITE_ERROR_UNSUPPORTED_QUERY</p></td>
<td class="enum_member_description">
<p>A query was not supported</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-UNSUPPORTED-FIELD:CAPS"></a>E_BOOK_SQLITE_ERROR_UNSUPPORTED_FIELD</p></td>
<td class="enum_member_description">
<p>An unsupported <a class="link" href="eds-EContact.html#EContactField" title="enum EContactField"><span class="type">EContactField</span></a> was specified in the summary</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-END-OF-LIST:CAPS"></a>E_BOOK_SQLITE_ERROR_END_OF_LIST</p></td>
<td class="enum_member_description">
<p>An attempt was made to fetch results past the end of a contact list</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-BOOK-SQLITE-ERROR-LOAD:CAPS"></a>E_BOOK_SQLITE_ERROR_LOAD</p></td>
<td class="enum_member_description">
<p>An error occured while loading or creating the database</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="EbSqlLockType"></a><h3>enum EbSqlLockType</h3>
<p>Indicates the type of lock requested in <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-lock" title="e_book_sqlite_lock ()"><code class="function">e_book_sqlite_lock()</code></a></p>
<div class="refsect3">
<a name="id-1.4.4.5.8.5.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-LOCK-READ:CAPS"></a>EBSQL_LOCK_READ</p></td>
<td class="enum_member_description">
<p>Obtain a lock for reading</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-LOCK-WRITE:CAPS"></a>EBSQL_LOCK_WRITE</p></td>
<td class="enum_member_description">
<p>Obtain a lock for writing</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="EbSqlUnlockAction"></a><h3>enum EbSqlUnlockAction</h3>
<p>Indicates what type of action to take while unlocking the sqlite with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-unlock" title="e_book_sqlite_unlock ()"><code class="function">e_book_sqlite_unlock()</code></a></p>
<p>In the case that some addressbook modification failed while holding an <a class="link" href="eds-EBookSqlite.html#EBSQL-LOCK-WRITE:CAPS"><code class="literal">EBSQL_LOCK_WRITE</code></a> lock,
then the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> must be unlocked with <a class="link" href="eds-EBookSqlite.html#EBSQL-UNLOCK-ROLLBACK:CAPS"><code class="literal">EBSQL_UNLOCK_ROLLBACK</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.8.6.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-UNLOCK-NONE:CAPS"></a>EBSQL_UNLOCK_NONE</p></td>
<td class="enum_member_description">
<p>Just unlock, this is appropriate for locks which were obtained with <a class="link" href="eds-EBookSqlite.html#EBSQL-LOCK-READ:CAPS"><code class="literal">EBSQL_LOCK_READ</code></a></p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-UNLOCK-COMMIT:CAPS"></a>EBSQL_UNLOCK_COMMIT</p></td>
<td class="enum_member_description">
<p>Commit any modifications which were made while the lock was held</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-UNLOCK-ROLLBACK:CAPS"></a>EBSQL_UNLOCK_ROLLBACK</p></td>
<td class="enum_member_description">
<p>Rollback any modifications which were made while the lock was held</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="EbSqlSearchData"></a><h3>EbSqlSearchData</h3>
<pre class="programlisting">typedef struct {
gchar *uid;
gchar *vcard;
gchar *extra;
} EbSqlSearchData;
</pre>
<p>This structure is used to represent contacts returned
by the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> from various functions
such as <code class="function">e_book_sqlitedb_search()</code>.</p>
<p>The <em class="parameter"><code>extra</code></em>
parameter will contain any data which was
previously passed for this contact in <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-add-contact" title="e_book_sqlite_add_contact ()"><code class="function">e_book_sqlite_add_contact()</code></a>.</p>
<p>These should be freed with <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-search-data-free" title="e_book_sqlite_search_data_free ()"><code class="function">e_book_sqlite_search_data_free()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.8.7.7"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EbSqlSearchData.uid"></a>uid</code></em>;</p></td>
<td class="struct_member_description"><p>The <a class="link" href="eds-EContact.html#E-CONTACT-UID:CAPS"><code class="literal">E_CONTACT_UID</code></a> field of this contact</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EbSqlSearchData.vcard"></a>vcard</code></em>;</p></td>
<td class="struct_member_description"><p>The the vcard string</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="EbSqlSearchData.extra"></a>extra</code></em>;</p></td>
<td class="struct_member_description"><p>Any extra data associated to the vcard</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="EBookSqlite"></a><h3>struct EBookSqlite</h3>
<pre class="programlisting">struct EBookSqlite {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</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="EBookSqliteClass"></a><h3>struct EBookSqliteClass</h3>
<pre class="programlisting">struct EBookSqliteClass {
};
</pre>
<p>Class structure for the <a class="link" href="eds-EBookSqlite.html#EBookSqlite" title="struct EBookSqlite"><span class="type">EBookSqlite</span></a> class.</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="EbSqlCursorOrigin"></a><h3>enum EbSqlCursorOrigin</h3>
<p>Specifies the start position to in the list of traversed contacts
in calls to <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-step" title="e_book_sqlite_cursor_step ()"><code class="function">e_book_sqlite_cursor_step()</code></a>.</p>
<p>When an <span class="type">EbSqlCuror</span> is created, the current position implied by <a class="link" href="eds-EBookSqlite.html#EBSQL-CURSOR-ORIGIN-CURRENT:CAPS"><code class="literal">EBSQL_CURSOR_ORIGIN_CURRENT</code></a>
is the same as <a class="link" href="eds-EBookSqlite.html#EBSQL-CURSOR-ORIGIN-BEGIN:CAPS"><code class="literal">EBSQL_CURSOR_ORIGIN_BEGIN</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.8.10.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CURSOR-ORIGIN-CURRENT:CAPS"></a>EBSQL_CURSOR_ORIGIN_CURRENT</p></td>
<td class="enum_member_description">
<p>The current cursor position</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CURSOR-ORIGIN-BEGIN:CAPS"></a>EBSQL_CURSOR_ORIGIN_BEGIN</p></td>
<td class="enum_member_description">
<p>The beginning of the cursor results.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CURSOR-ORIGIN-END:CAPS"></a>EBSQL_CURSOR_ORIGIN_END</p></td>
<td class="enum_member_description">
<p>The ending of the cursor results.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="EbSqlCursorStepFlags"></a><h3>enum EbSqlCursorStepFlags</h3>
<p>Defines the behaviour of <a class="link" href="eds-EBookSqlite.html#e-book-sqlite-cursor-step" title="e_book_sqlite_cursor_step ()"><code class="function">e_book_sqlite_cursor_step()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.4.5.8.11.4"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CURSOR-STEP-MOVE:CAPS"></a>EBSQL_CURSOR_STEP_MOVE</p></td>
<td class="enum_member_description">
<p>The cursor position should be modified while stepping</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="EBSQL-CURSOR-STEP-FETCH:CAPS"></a>EBSQL_CURSOR_STEP_FETCH</p></td>
<td class="enum_member_description">
<p>Traversed contacts should be listed and returned while stepping.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
<hr>
<div class="refsect2">
<a name="EbSqlCursor"></a><h3>EbSqlCursor</h3>
<pre class="programlisting">typedef struct _EbSqlCursor EbSqlCursor;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|