<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Kyoto Cabinet: kclangc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>kclangc.h File Reference</h1>
<p>C language binding.
<a href="#_details">More...</a></p>
<code>#include <assert.h></code><br/>
<code>#include <ctype.h></code><br/>
<code>#include <errno.h></code><br/>
<code>#include <float.h></code><br/>
<code>#include <limits.h></code><br/>
<code>#include <locale.h></code><br/>
<code>#include <math.h></code><br/>
<code>#include <setjmp.h></code><br/>
<code>#include <stdarg.h></code><br/>
<code>#include <stddef.h></code><br/>
<code>#include <stdio.h></code><br/>
<code>#include <stdlib.h></code><br/>
<code>#include <signal.h></code><br/>
<code>#include <string.h></code><br/>
<code>#include <time.h></code><br/>
<code>#include <stdint.h></code><br/>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">union </td><td class="memItemRight" valign="bottom"><a class="el" href="unionKCDB.html">KCDB</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">C wrapper of polymorphic database. <a href="unionKCDB.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">union </td><td class="memItemRight" valign="bottom"><a class="el" href="unionKCCUR.html">KCCUR</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">C wrapper of polymorphic cursor. <a href="unionKCCUR.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> )(const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp, void *opq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Call back function to visit a full record. <a href="#ad5322730d6c138c6c32bd501fc2c09e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef const char *(* </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ab81f0ec8b8a935f708fa60faadea86b2">KCVISITEMPTY</a> )(const char *kbuf, size_t ksiz, size_t *sp, void *opq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Call back function to visit an empty record. <a href="#ab81f0ec8b8a935f708fa60faadea86b2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int32_t(* </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a55e9f27415a9ee1d641cef35cc518b8f">KCFILEPROC</a> )(const char *path, int64_t count, int64_t size, void *opq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Call back function to process the database file. <a href="#a55e9f27415a9ee1d641cef35cc518b8f"></a><br/></td></tr>
<tr><td colspan="2"><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br/>
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55bae63556b5f2db4514dbc65f5239c8ab93">KCESUCCESS</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55bab3f263d57aa936e9c779e36b41d85610">KCENOIMPL</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55bafbe5a2cf60834bee0e3c1f1be1112ce0">KCEINVALID</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55bafd68de6057f376ad27e665e87aa93b11">KCENOREPOS</a>,
<br/>
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55badcc02ab4f73e617e15187eb1a957e940">KCENOPERM</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55baa410ac67a3a382b82489f214760aac72">KCEBROKEN</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba57438217f0372508a82b67810b22a574">KCEDUPREC</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba733e62fc2f1bb695d01bdcc767d0cecc">KCENOREC</a>,
<br/>
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba356efe2c5d4bfd9eeb75ee624cf628ef">KCELOGIC</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55baa693fa4d5e7ddc6ef447ab7dd74bd2e9">KCESYSTEM</a>,
<a class="el" href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba335ef8482ec4222a3451b581c16763df">KCEMISC</a> = 15
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Error codes. </p>
<a href="kclangc_8h.html#a06fc87d81c62e9abb8790b6e5713c55b">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <br/>
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a0f7b0c307ecf7f585c587c327dcf4dd0">KCOREADER</a> = 1 << 0,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a352bdce1311ada70fcaf2f22194cbbdf">KCOWRITER</a> = 1 << 1,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a8aae26396f1c8062f63ff6319430116f">KCOCREATE</a> = 1 << 2,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a9e0ac6a46aa682fb9715a9e85d1099c5">KCOTRUNCATE</a> = 1 << 3,
<br/>
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7ae56445cf7149ea1f695bc94cfdf3f4bc">KCOAUTOTRAN</a> = 1 << 4,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a15a52d713c51b5d93a73938b1b3371c6">KCOAUTOSYNC</a> = 1 << 5,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7aa4ba32fada5f28c0115b915eecdbcbeb">KCONOLOCK</a> = 1 << 6,
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7aba88ffe5dfdf69d1d53622a9ee413005">KCOTRYLOCK</a> = 1 << 7,
<br/>
<a class="el" href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7a5fec9b7c910416b0f80dbbca897e5d82">KCONOREPAIR</a> = 1 << 8
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Open modes. </p>
<a href="kclangc_8h.html#adf764cbdea00d65edcd07bb9953ad2b7">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom">{ <a class="el" href="kclangc_8h.html#a99fb83031ce9923c84392b4e92f956b5a667ff146032bee5aad8d51689ea97586">KCMSET</a>,
<a class="el" href="kclangc_8h.html#a99fb83031ce9923c84392b4e92f956b5a57460294be785b3fd21eeef5083c21fd">KCMADD</a>,
<a class="el" href="kclangc_8h.html#a99fb83031ce9923c84392b4e92f956b5a9d1a001b2b5a859ab285edda8537c0ef">KCMREPLACE</a>,
<a class="el" href="kclangc_8h.html#a99fb83031ce9923c84392b4e92f956b5a6af08f4fb0a0543d25c0469462195a8a">KCMAPPEND</a>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Merge modes. </p>
<a href="kclangc_8h.html#a99fb83031ce9923c84392b4e92f956b5">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a30be9af70a790af59d7c8fb2e9aa7c20">kcmalloc</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a region on memory. <a href="#a30be9af70a790af59d7c8fb2e9aa7c20"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aba875623bd102d078eb328a1eb7bc0f6">kcfree</a> (void *ptr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a region allocated in the library. <a href="#aba875623bd102d078eb328a1eb7bc0f6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#acf8a78ec339dbdacb7451d7eaa2abb45">kctime</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the time of day in seconds. <a href="#acf8a78ec339dbdacb7451d7eaa2abb45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a937d5246c18410ed598d9c061b04504a">kcatoi</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to an integer. <a href="#a937d5246c18410ed598d9c061b04504a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a585366f65f8332aa439e6b640823894f">kcatoix</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string with a metric prefix to an integer. <a href="#a585366f65f8332aa439e6b640823894f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ac89ecc6c9417a0f38ada1417b84adf04">kcatof</a> (const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to a real number. <a href="#ac89ecc6c9417a0f38ada1417b84adf04"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a943ec205ec42c2ec60b7823f0b0769da">kchashmurmur</a> (const void *buf, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hash value by MurMur hashing. <a href="#a943ec205ec42c2ec60b7823f0b0769da"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a7a6541052e2e0810b11ef7e51a80da3f">kchashfnv</a> (const void *buf, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hash value by FNV hashing. <a href="#a7a6541052e2e0810b11ef7e51a80da3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ad1e7b041ebb62e5e08166d091c90b3e3">kcnan</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the quiet Not-a-Number value. <a href="#ad1e7b041ebb62e5e08166d091c90b3e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a304f691cdbf2d9bb1cd14c789973c56a">kcinf</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the positive infinity value. <a href="#a304f691cdbf2d9bb1cd14c789973c56a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a0b7d3cfd745e92ee2d9fe43f058b68c3">kcchknan</a> (double num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check a number is a Not-a-Number value. <a href="#a0b7d3cfd745e92ee2d9fe43f058b68c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ad237cdbe33ea8b918979bfbbb78b7d64">kcchkinf</a> (double num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check a number is an infinity value. <a href="#ad237cdbe33ea8b918979bfbbb78b7d64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a7c345d19eb7072e55e54091467d269d7">kcecodename</a> (int32_t code)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the readable string of an error code. <a href="#a7c345d19eb7072e55e54091467d269d7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionKCDB.html">KCDB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a485c6993061575b14c4615988e694a15">kcdbnew</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a database object. <a href="#a485c6993061575b14c4615988e694a15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a6bbf9098efff747475f6e9098a8a6844">kcdbdel</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a database object. <a href="#a6bbf9098efff747475f6e9098a8a6844"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a464237fa818e4b70b15526a898b5c5f5">kcdbopen</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *path, uint32_t mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Open a database file. <a href="#a464237fa818e4b70b15526a898b5c5f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#adbbfc05c79211f4f70f179579f4f3f00">kcdbclose</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the database file. <a href="#adbbfc05c79211f4f70f179579f4f3f00"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a686a89045f646d5a7bbb87f264cd7e3a">kcdbecode</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the code of the last happened error. <a href="#a686a89045f646d5a7bbb87f264cd7e3a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ac0b1a4d349d567450437467155d43439">kcdbemsg</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the supplement message of the last happened error. <a href="#ac0b1a4d349d567450437467155d43439"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a6bca0b4da37a96a6673e834567a7886a">kcdbaccept</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, <a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> fullproc, <a class="el" href="kclangc_8h.html#ab81f0ec8b8a935f708fa60faadea86b2">KCVISITEMPTY</a> emptyproc, void *opq, int32_t writable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a visitor to a record. <a href="#a6bca0b4da37a96a6673e834567a7886a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a01828d3ba1b4e624683faea5311cfac0">kcdbiterate</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, <a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> fullproc, void *opq, int32_t writable)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate to accept a visitor for each record. <a href="#a01828d3ba1b4e624683faea5311cfac0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#acc94df95a0d8863c450a649bdc546eaf">kcdbset</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of a record. <a href="#acc94df95a0d8863c450a649bdc546eaf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a73fe31f31713e4951c3b4392d1c0d818">kcdbadd</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a record. <a href="#a73fe31f31713e4951c3b4392d1c0d818"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a14738a439d37fa7ea3d60a1a677834c8">kcdbreplace</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replace the value of a record. <a href="#a14738a439d37fa7ea3d60a1a677834c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a2c2b464eedd23c73690ef6824206aded">kcdbappend</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append the value of a record. <a href="#a2c2b464eedd23c73690ef6824206aded"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aa56aefce671acb4f4144a17776182d3f">kcdbincrint</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, int64_t num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a number to the numeric value of a record. <a href="#aa56aefce671acb4f4144a17776182d3f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aceb58a120d0ecf01d0eaebea514a8680">kcdbincrdouble</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, double num)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a number to the numeric value of a record. <a href="#aceb58a120d0ecf01d0eaebea514a8680"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aed4df56efddad19e03ccf6c6ea329e6c">kcdbcas</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, const char *nvbuf, size_t nvsiz, const char *ovbuf, size_t ovsiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform compare-and-swap. <a href="#aed4df56efddad19e03ccf6c6ea329e6c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aec78ac6dc641edb8f5dd74370f4010a6">kcdbremove</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove a record. <a href="#aec78ac6dc641edb8f5dd74370f4010a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ab552d20a2af1375b24aba34f412302d0">kcdbget</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, size_t *sp)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the value of a record. <a href="#ab552d20a2af1375b24aba34f412302d0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ac383a4611e359530c28d746d52112219">kcdbgetbuf</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *kbuf, size_t ksiz, char *vbuf, size_t max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the value of a record. <a href="#ac383a4611e359530c28d746d52112219"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a853dea5181512c82535be1c0e32f765f">kcdbclear</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all records. <a href="#a853dea5181512c82535be1c0e32f765f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a8013c2ac28dcbde074cd2aa9a58aa72f">kcdbsync</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, int32_t hard, <a class="el" href="kclangc_8h.html#a55e9f27415a9ee1d641cef35cc518b8f">KCFILEPROC</a> proc, void *opq)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize updated contents with the file and the device. <a href="#a8013c2ac28dcbde074cd2aa9a58aa72f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a9876214275221936d62b620f49b34570">kcdbcopy</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of the database file. <a href="#a9876214275221936d62b620f49b34570"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a531f94f519cd35a5fc7bc1e0ef04ece8">kcdbbegintran</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, int32_t hard)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin transaction. <a href="#a531f94f519cd35a5fc7bc1e0ef04ece8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#af00b9f2ed98722be9399d492e6c33a64">kcdbbegintrantry</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, int32_t hard)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Try to begin transaction. <a href="#af00b9f2ed98722be9399d492e6c33a64"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a288565a6579bc9125390c752be829804">kcdbendtran</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, int32_t commit)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End transaction. <a href="#a288565a6579bc9125390c752be829804"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ad2b07256a5236ba981be4a863ada8e43">kcdbdumpsnap</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *dest)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Dump records into a file. <a href="#ad2b07256a5236ba981be4a863ada8e43"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#af283ad00d5f46edd883356a4b3f9e979">kcdbloadsnap</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *src)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load records from a file. <a href="#af283ad00d5f46edd883356a4b3f9e979"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#afa5d9b2da776853efae3abb20ad562c4">kcdbcount</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of records. <a href="#afa5d9b2da776853efae3abb20ad562c4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a278ea62b6ba5c9cabeadc77a1cde213c">kcdbsize</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the database file. <a href="#a278ea62b6ba5c9cabeadc77a1cde213c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a87de7082c3f19fd255b431f0ccb92f44">kcdbpath</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the path of the database file. <a href="#a87de7082c3f19fd255b431f0ccb92f44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a156561acce1ad4f2db9c00f1b5c01e7b">kcdbstatus</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the miscellaneous status information. <a href="#a156561acce1ad4f2db9c00f1b5c01e7b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#ad5c2697cda42ae1ddda0232124add786">kcdbmatchprefix</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *prefix, char **strary, int64_t max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get keys matching a prefix string. <a href="#ad5c2697cda42ae1ddda0232124add786"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a896e2c260e06f135d33af4df75c72e49">kcdbmatchregex</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, const char *regex, char **strary, int64_t max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get keys matching a regular expression string. <a href="#a896e2c260e06f135d33af4df75c72e49"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a20e630cadb0b3518c13c9ca6cff60aed">kcdbmerge</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db, <a class="el" href="unionKCDB.html">KCDB</a> **srcary, size_t srcnum, uint32_t mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Merge records from other databases. <a href="#a20e630cadb0b3518c13c9ca6cff60aed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#adccaf4771f7804511791af33a316e0ba">kcdbcursor</a> (<a class="el" href="unionKCDB.html">KCDB</a> *db)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a cursor object. <a href="#adccaf4771f7804511791af33a316e0ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a88d85075827598fa94c6fd4c3430389f">kccurdel</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a cursor object. <a href="#a88d85075827598fa94c6fd4c3430389f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a7ca1819141a1554397bbfede6d6f325e">kccuraccept</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, <a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> fullproc, void *opq, int32_t writable, int32_t step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Accept a visitor to the current record. <a href="#a7ca1819141a1554397bbfede6d6f325e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#abf07e20809ce5927f81ed055e0c8c637">kccursetvalue</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, const char *vbuf, size_t vsiz, int32_t step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of the current record. <a href="#abf07e20809ce5927f81ed055e0c8c637"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a0867dbd783e2a23c1a6be653d8e41bdd">kccurremove</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the current record. <a href="#a0867dbd783e2a23c1a6be653d8e41bdd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a1f15ef59f87b34eeeb4374c847d67b4b">kccurgetkey</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, size_t *sp, int32_t step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the key of the current record. <a href="#a1f15ef59f87b34eeeb4374c847d67b4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a5ebbb378e935cd773107503d7d4d466c">kccurgetvalue</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, size_t *sp, int32_t step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the current record. <a href="#a5ebbb378e935cd773107503d7d4d466c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a543b0095fb011f3ae42424460190d25a">kccurget</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, size_t *ksp, const char **vbp, size_t *vsp, int32_t step)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a pair of the key and the value of the current record. <a href="#a543b0095fb011f3ae42424460190d25a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a086c2e825133e414430ebd9fa010c9e0">kccurjump</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the first record for forward scan. <a href="#a086c2e825133e414430ebd9fa010c9e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a6b02b505678f971be270e3ba9a1b4d76">kccurjumpkey</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, const char *kbuf, size_t ksiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for forward scan. <a href="#a6b02b505678f971be270e3ba9a1b4d76"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#aea97152d108e403d57d6de9b9b9c905c">kccurjumpback</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to the last record for backward scan. <a href="#aea97152d108e403d57d6de9b9b9c905c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a6a64ab5f495da06c7361f010caa9371a">kccurjumpbackkey</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur, const char *kbuf, size_t ksiz)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Jump the cursor to a record for backward scan. <a href="#a6a64ab5f495da06c7361f010caa9371a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a8eb7192456824eaad2e15444704e9055">kccurstep</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the next record. <a href="#a8eb7192456824eaad2e15444704e9055"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#afeb16bd9461ab3f5dc2d21fa3ba28213">kccurstepback</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Step the cursor to the previous record. <a href="#afeb16bd9461ab3f5dc2d21fa3ba28213"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionKCDB.html">KCDB</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a20a80ae0156692ad33cd0b8bfcf7eeab">kccurdb</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the database object. <a href="#a20a80ae0156692ad33cd0b8bfcf7eeab"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a479ed6830ab7fb85b146bff54f67df23">kccurecode</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the code of the last happened error. <a href="#a479ed6830ab7fb85b146bff54f67df23"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a46daaae1cd681d037e3f45fb6028f03c">kccuremsg</a> (<a class="el" href="unionKCCUR.html">KCCUR</a> *cur)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the supplement message of the last happened error. <a href="#a46daaae1cd681d037e3f45fb6028f03c"></a><br/></td></tr>
<tr><td colspan="2"><h2>Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a2b538a7a564d0fbd9fe92d9877b4bcb0">KCVERSION</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The package version. <a href="#a2b538a7a564d0fbd9fe92d9877b4bcb0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a64c59ac34c88a862d2066d9097b09504">KCVISNOP</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special pointer for no operation by the visiting function. <a href="#a64c59ac34c88a862d2066d9097b09504"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *const </td><td class="memItemRight" valign="bottom"><a class="el" href="kclangc_8h.html#a8db7ac3c4e7d52ee1106a527a1bae0c8">KCVISREMOVE</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Special pointer to remove the record by the visiting function. <a href="#a8db7ac3c4e7d52ee1106a527a1bae0c8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>C language binding. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ad5322730d6c138c6c32bd501fc2c09e3"></a><!-- doxytag: member="kclangc.h::KCVISITFULL" ref="ad5322730d6c138c6c32bd501fc2c09e3" args=")(const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp, void *opq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const char*(* <a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a>)(const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz, size_t *sp, void *opq)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call back function to visit a full record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is KCVISNOP, nothing is modified. If it is KCVISREMOVE, the record is removed. </dd></dl>
</div>
</div>
<a class="anchor" id="ab81f0ec8b8a935f708fa60faadea86b2"></a><!-- doxytag: member="kclangc.h::KCVISITEMPTY" ref="ab81f0ec8b8a935f708fa60faadea86b2" args=")(const char *kbuf, size_t ksiz, size_t *sp, void *opq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const char*(* <a class="el" href="kclangc_8h.html#ab81f0ec8b8a935f708fa60faadea86b2">KCVISITEMPTY</a>)(const char *kbuf, size_t ksiz, size_t *sp, void *opq)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call back function to visit an empty record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>If it is the pointer to a region, the value is replaced by the content. If it is KCVISNOP or KCVISREMOVE, nothing is modified. </dd></dl>
</div>
</div>
<a class="anchor" id="a55e9f27415a9ee1d641cef35cc518b8f"></a><!-- doxytag: member="kclangc.h::KCFILEPROC" ref="a55e9f27415a9ee1d641cef35cc518b8f" args=")(const char *path, int64_t count, int64_t size, void *opq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32_t(* <a class="el" href="kclangc_8h.html#a55e9f27415a9ee1d641cef35cc518b8f">KCFILEPROC</a>)(const char *path, int64_t count, int64_t size, void *opq)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call back function to process the database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the path of the database file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>count</em> </td><td>the number of records. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the size of the available region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55b"></a><!-- doxytag: member="kclangc.h::@0" ref="a06fc87d81c62e9abb8790b6e5713c55b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Error codes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55bae63556b5f2db4514dbc65f5239c8ab93"></a><!-- doxytag: member="KCESUCCESS" ref="a06fc87d81c62e9abb8790b6e5713c55bae63556b5f2db4514dbc65f5239c8ab93" args="" -->KCESUCCESS</em> </td><td>
<p>success </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55bab3f263d57aa936e9c779e36b41d85610"></a><!-- doxytag: member="KCENOIMPL" ref="a06fc87d81c62e9abb8790b6e5713c55bab3f263d57aa936e9c779e36b41d85610" args="" -->KCENOIMPL</em> </td><td>
<p>not implemented </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55bafbe5a2cf60834bee0e3c1f1be1112ce0"></a><!-- doxytag: member="KCEINVALID" ref="a06fc87d81c62e9abb8790b6e5713c55bafbe5a2cf60834bee0e3c1f1be1112ce0" args="" -->KCEINVALID</em> </td><td>
<p>invalid operation </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55bafd68de6057f376ad27e665e87aa93b11"></a><!-- doxytag: member="KCENOREPOS" ref="a06fc87d81c62e9abb8790b6e5713c55bafd68de6057f376ad27e665e87aa93b11" args="" -->KCENOREPOS</em> </td><td>
<p>no repository </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55badcc02ab4f73e617e15187eb1a957e940"></a><!-- doxytag: member="KCENOPERM" ref="a06fc87d81c62e9abb8790b6e5713c55badcc02ab4f73e617e15187eb1a957e940" args="" -->KCENOPERM</em> </td><td>
<p>no permission </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55baa410ac67a3a382b82489f214760aac72"></a><!-- doxytag: member="KCEBROKEN" ref="a06fc87d81c62e9abb8790b6e5713c55baa410ac67a3a382b82489f214760aac72" args="" -->KCEBROKEN</em> </td><td>
<p>broken file </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba57438217f0372508a82b67810b22a574"></a><!-- doxytag: member="KCEDUPREC" ref="a06fc87d81c62e9abb8790b6e5713c55ba57438217f0372508a82b67810b22a574" args="" -->KCEDUPREC</em> </td><td>
<p>record duplication </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba733e62fc2f1bb695d01bdcc767d0cecc"></a><!-- doxytag: member="KCENOREC" ref="a06fc87d81c62e9abb8790b6e5713c55ba733e62fc2f1bb695d01bdcc767d0cecc" args="" -->KCENOREC</em> </td><td>
<p>no record </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba356efe2c5d4bfd9eeb75ee624cf628ef"></a><!-- doxytag: member="KCELOGIC" ref="a06fc87d81c62e9abb8790b6e5713c55ba356efe2c5d4bfd9eeb75ee624cf628ef" args="" -->KCELOGIC</em> </td><td>
<p>logical inconsistency </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55baa693fa4d5e7ddc6ef447ab7dd74bd2e9"></a><!-- doxytag: member="KCESYSTEM" ref="a06fc87d81c62e9abb8790b6e5713c55baa693fa4d5e7ddc6ef447ab7dd74bd2e9" args="" -->KCESYSTEM</em> </td><td>
<p>system error </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a06fc87d81c62e9abb8790b6e5713c55ba335ef8482ec4222a3451b581c16763df"></a><!-- doxytag: member="KCEMISC" ref="a06fc87d81c62e9abb8790b6e5713c55ba335ef8482ec4222a3451b581c16763df" args="" -->KCEMISC</em> </td><td>
<p>miscellaneous error </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7"></a><!-- doxytag: member="kclangc.h::@1" ref="adf764cbdea00d65edcd07bb9953ad2b7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open modes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a0f7b0c307ecf7f585c587c327dcf4dd0"></a><!-- doxytag: member="KCOREADER" ref="adf764cbdea00d65edcd07bb9953ad2b7a0f7b0c307ecf7f585c587c327dcf4dd0" args="" -->KCOREADER</em> </td><td>
<p>open as a reader </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a352bdce1311ada70fcaf2f22194cbbdf"></a><!-- doxytag: member="KCOWRITER" ref="adf764cbdea00d65edcd07bb9953ad2b7a352bdce1311ada70fcaf2f22194cbbdf" args="" -->KCOWRITER</em> </td><td>
<p>open as a writer </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a8aae26396f1c8062f63ff6319430116f"></a><!-- doxytag: member="KCOCREATE" ref="adf764cbdea00d65edcd07bb9953ad2b7a8aae26396f1c8062f63ff6319430116f" args="" -->KCOCREATE</em> </td><td>
<p>writer creating </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a9e0ac6a46aa682fb9715a9e85d1099c5"></a><!-- doxytag: member="KCOTRUNCATE" ref="adf764cbdea00d65edcd07bb9953ad2b7a9e0ac6a46aa682fb9715a9e85d1099c5" args="" -->KCOTRUNCATE</em> </td><td>
<p>writer truncating </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7ae56445cf7149ea1f695bc94cfdf3f4bc"></a><!-- doxytag: member="KCOAUTOTRAN" ref="adf764cbdea00d65edcd07bb9953ad2b7ae56445cf7149ea1f695bc94cfdf3f4bc" args="" -->KCOAUTOTRAN</em> </td><td>
<p>auto transaction </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a15a52d713c51b5d93a73938b1b3371c6"></a><!-- doxytag: member="KCOAUTOSYNC" ref="adf764cbdea00d65edcd07bb9953ad2b7a15a52d713c51b5d93a73938b1b3371c6" args="" -->KCOAUTOSYNC</em> </td><td>
<p>auto synchronization </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7aa4ba32fada5f28c0115b915eecdbcbeb"></a><!-- doxytag: member="KCONOLOCK" ref="adf764cbdea00d65edcd07bb9953ad2b7aa4ba32fada5f28c0115b915eecdbcbeb" args="" -->KCONOLOCK</em> </td><td>
<p>open without locking </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7aba88ffe5dfdf69d1d53622a9ee413005"></a><!-- doxytag: member="KCOTRYLOCK" ref="adf764cbdea00d65edcd07bb9953ad2b7aba88ffe5dfdf69d1d53622a9ee413005" args="" -->KCOTRYLOCK</em> </td><td>
<p>lock without blocking </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="adf764cbdea00d65edcd07bb9953ad2b7a5fec9b7c910416b0f80dbbca897e5d82"></a><!-- doxytag: member="KCONOREPAIR" ref="adf764cbdea00d65edcd07bb9953ad2b7a5fec9b7c910416b0f80dbbca897e5d82" args="" -->KCONOREPAIR</em> </td><td>
<p>open without auto repair </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a99fb83031ce9923c84392b4e92f956b5"></a><!-- doxytag: member="kclangc.h::@2" ref="a99fb83031ce9923c84392b4e92f956b5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Merge modes. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a99fb83031ce9923c84392b4e92f956b5a667ff146032bee5aad8d51689ea97586"></a><!-- doxytag: member="KCMSET" ref="a99fb83031ce9923c84392b4e92f956b5a667ff146032bee5aad8d51689ea97586" args="" -->KCMSET</em> </td><td>
<p>overwrite the existing value </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a99fb83031ce9923c84392b4e92f956b5a57460294be785b3fd21eeef5083c21fd"></a><!-- doxytag: member="KCMADD" ref="a99fb83031ce9923c84392b4e92f956b5a57460294be785b3fd21eeef5083c21fd" args="" -->KCMADD</em> </td><td>
<p>keep the existing value </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a99fb83031ce9923c84392b4e92f956b5a9d1a001b2b5a859ab285edda8537c0ef"></a><!-- doxytag: member="KCMREPLACE" ref="a99fb83031ce9923c84392b4e92f956b5a9d1a001b2b5a859ab285edda8537c0ef" args="" -->KCMREPLACE</em> </td><td>
<p>modify the existing record only </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a99fb83031ce9923c84392b4e92f956b5a6af08f4fb0a0543d25c0469462195a8a"></a><!-- doxytag: member="KCMAPPEND" ref="a99fb83031ce9923c84392b4e92f956b5a6af08f4fb0a0543d25c0469462195a8a" args="" -->KCMAPPEND</em> </td><td>
<p>append the new value </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a30be9af70a790af59d7c8fb2e9aa7c20"></a><!-- doxytag: member="kclangc.h::kcmalloc" ref="a30be9af70a790af59d7c8fb2e9aa7c20" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* kcmalloc </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate a region on memory. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the size of the region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the allocated region. The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="aba875623bd102d078eb328a1eb7bc0f6"></a><!-- doxytag: member="kclangc.h::kcfree" ref="aba875623bd102d078eb328a1eb7bc0f6" args="(void *ptr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kcfree </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>ptr</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release a region allocated in the library. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>the pointer to the region. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acf8a78ec339dbdacb7451d7eaa2abb45"></a><!-- doxytag: member="kclangc.h::kctime" ref="acf8a78ec339dbdacb7451d7eaa2abb45" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double kctime </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the time of day in seconds. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the time of day in seconds. The accuracy is in microseconds. </dd></dl>
</div>
</div>
<a class="anchor" id="a937d5246c18410ed598d9c061b04504a"></a><!-- doxytag: member="kclangc.h::kcatoi" ref="a937d5246c18410ed598d9c061b04504a" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcatoi </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a string to an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>specifies the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the integer. If the string does not contain numeric expression, 0 is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a585366f65f8332aa439e6b640823894f"></a><!-- doxytag: member="kclangc.h::kcatoix" ref="a585366f65f8332aa439e6b640823894f" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcatoix </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a string with a metric prefix to an integer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string, which can be trailed by a binary metric prefix. "K", "M", "G", "T", "P", and "E" are supported. They are case-insensitive. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the integer. If the string does not contain numeric expression, 0 is returned. If the integer overflows the domain, INT64_MAX or INT64_MIN is returned according to the sign. </dd></dl>
</div>
</div>
<a class="anchor" id="ac89ecc6c9417a0f38ada1417b84adf04"></a><!-- doxytag: member="kclangc.h::kcatof" ref="ac89ecc6c9417a0f38ada1417b84adf04" args="(const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double kcatof </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a string to a real number. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>specifies the string. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the real number. If the string does not contain numeric expression, 0.0 is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a943ec205ec42c2ec60b7823f0b0769da"></a><!-- doxytag: member="kclangc.h::kchashmurmur" ref="a943ec205ec42c2ec60b7823f0b0769da" args="(const void *buf, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t kchashmurmur </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the hash value by MurMur hashing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>the source buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the size of the source buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the hash value. </dd></dl>
</div>
</div>
<a class="anchor" id="a7a6541052e2e0810b11ef7e51a80da3f"></a><!-- doxytag: member="kclangc.h::kchashfnv" ref="a7a6541052e2e0810b11ef7e51a80da3f" args="(const void *buf, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t kchashfnv </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the hash value by FNV hashing. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>the source buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>the size of the source buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the hash value. </dd></dl>
</div>
</div>
<a class="anchor" id="ad1e7b041ebb62e5e08166d091c90b3e3"></a><!-- doxytag: member="kclangc.h::kcnan" ref="ad1e7b041ebb62e5e08166d091c90b3e3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double kcnan </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the quiet Not-a-Number value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the quiet Not-a-Number value. </dd></dl>
</div>
</div>
<a class="anchor" id="a304f691cdbf2d9bb1cd14c789973c56a"></a><!-- doxytag: member="kclangc.h::kcinf" ref="a304f691cdbf2d9bb1cd14c789973c56a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double kcinf </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the positive infinity value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the positive infinity value. </dd></dl>
</div>
</div>
<a class="anchor" id="a0b7d3cfd745e92ee2d9fe43f058b68c3"></a><!-- doxytag: member="kclangc.h::kcchknan" ref="a0b7d3cfd745e92ee2d9fe43f058b68c3" args="(double num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcchknan </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>num</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check a number is a Not-a-Number value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true for the number is a Not-a-Number value, or false if not. </dd></dl>
</div>
</div>
<a class="anchor" id="ad237cdbe33ea8b918979bfbbb78b7d64"></a><!-- doxytag: member="kclangc.h::kcchkinf" ref="ad237cdbe33ea8b918979bfbbb78b7d64" args="(double num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcchkinf </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>num</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check a number is an infinity value. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true for the number is an infinity value, or false if not. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c345d19eb7072e55e54091467d269d7"></a><!-- doxytag: member="kclangc.h::kcecodename" ref="a7c345d19eb7072e55e54091467d269d7" args="(int32_t code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kcecodename </td>
<td>(</td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>code</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the readable string of an error code. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>the error code. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the readable string of the error code. </dd></dl>
</div>
</div>
<a class="anchor" id="a485c6993061575b14c4615988e694a15"></a><!-- doxytag: member="kclangc.h::kcdbnew" ref="a485c6993061575b14c4615988e694a15" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionKCDB.html">KCDB</a>* kcdbnew </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a database object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the created database object. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The object of the return value should be released with the kcdbdel function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a6bbf9098efff747475f6e9098a8a6844"></a><!-- doxytag: member="kclangc.h::kcdbdel" ref="a6bbf9098efff747475f6e9098a8a6844" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kcdbdel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a database object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>the database object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a464237fa818e4b70b15526a898b5c5f5"></a><!-- doxytag: member="kclangc.h::kcdbopen" ref="a464237fa818e4b70b15526a898b5c5f5" args="(KCDB *db, const char *path, uint32_t mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbopen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Open a database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>the path of a database file. If it is "-", the database will be a prototype hash database. If it is "+", the database will be a prototype tree database. If it is "*", the database will be a cache hash database. If it is "%", the database will be a cache tree database. If its suffix is ".kch", the database will be a file hash database. If its suffix is ".kct", the database will be a file tree database. If its suffix is ".kcd", the database will be a directory hash database. If its suffix is ".kcf", the database will be a directory tree database. Otherwise, this function fails. Tuning parameters can trail the name, separated by "#". Each parameter is composed of the name and the value, separated by "=". If the "type" parameter is specified, the database type is determined by the value in "-", "+", "*", "%", "kch", "kct", "kcd", and "kcf". All database types support the logging parameters of "log", "logkinds", and "logpx". The prototype hash database and the prototype tree database do not support any other tuning parameter. The cache hash database supports "opts", "bnum", "zcomp", "capcount", "capsize", and "zkey". The cache tree database supports all parameters of the cache hash database except for capacity limitation, and supports "psiz", "rcomp", "pccap" in addition. The file hash database supports "apow", "fpow", "opts", "bnum", "msiz", "dfunit", "zcomp", and "zkey". The file tree database supports all parameters of the file hash database and "psiz", "rcomp", "pccap" in addition. The directory hash database supports "opts", "zcomp", and "zkey". The directory tree database supports all parameters of the directory hash database and "psiz", "rcomp", "pccap" in addition. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>the connection mode. KCOWRITER as a writer, KCOREADER as a reader. The following may be added to the writer mode by bitwise-or: KCOCREATE, which means it creates a new database if the file does not exist, KCOTRUNCATE, which means it creates a new database regardless if the file exists, KCOAUTOTRAN, which means each updating operation is performed in implicit transaction, KCOAUTOSYNC, which means each updating operation is followed by implicit synchronization with the file system. The following may be added to both of the reader mode and the writer mode by bitwise-or: KCONOLOCK, which means it opens the database file without file locking, KCOTRYLOCK, which means locking is performed without blocking, KCONOREPAIR, which means the database file is not repaired implicitly even if file destruction is detected. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The tuning parameter "log" is for the original "tune_logger" and the value specifies the path of the log file, or "-" for the standard output, or "+" for the standard error. "logkinds" specifies kinds of logged messages and the value can be "debug", "info", "warn", or "error". "logpx" specifies the prefix of each log message. "opts" is for "tune_options" and the value can contain "s" for the small option, "l" for the linear option, and "c" for the compress option. "bnum" corresponds to "tune_bucket". "zcomp" is for "tune_compressor" and the value can be "zlib" for the ZLIB raw compressor, "def" for the ZLIB deflate compressor, "gz" for the ZLIB gzip compressor, "lzo" for the LZO compressor, "lzma" for the LZMA compressor, or "arc" for the Arcfour cipher. "zkey" specifies the cipher key of the compressor. "capcount" is for "cap_count". "capsize" is for "cap_size". "psiz" is for "tune_page". "rcomp" is for "tune_comparator" and the value can be "lex" for the lexical comparator or "dec" for the decimal comparator. "pccap" is for "tune_page_cache". "apow" is for "tune_alignment". "fpow" is for "tune_fbp". "msiz" is for "tune_map". "dfunit" is for "tune_defrag". Every opened database must be closed by the kcdbclose method when it is no longer in use. It is not allowed for two or more database objects in the same process to keep their connections to the same database file at the same time. </dd></dl>
</div>
</div>
<a class="anchor" id="adbbfc05c79211f4f70f179579f4f3f00"></a><!-- doxytag: member="kclangc.h::kcdbclose" ref="adbbfc05c79211f4f70f179579f4f3f00" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbclose </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Close the database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a686a89045f646d5a7bbb87f264cd7e3a"></a><!-- doxytag: member="kclangc.h::kcdbecode" ref="a686a89045f646d5a7bbb87f264cd7e3a" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbecode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the code of the last happened error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the code of the last happened error. </dd></dl>
</div>
</div>
<a class="anchor" id="ac0b1a4d349d567450437467155d43439"></a><!-- doxytag: member="kclangc.h::kcdbemsg" ref="ac0b1a4d349d567450437467155d43439" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kcdbemsg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the supplement message of the last happened error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the supplement message of the last happened error. </dd></dl>
</div>
</div>
<a class="anchor" id="a6bca0b4da37a96a6673e834567a7886a"></a><!-- doxytag: member="kclangc.h::kcdbaccept" ref="a6bca0b4da37a96a6673e834567a7886a" args="(KCDB *db, const char *kbuf, size_t ksiz, KCVISITFULL fullproc, KCVISITEMPTY emptyproc, void *opq, int32_t writable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbaccept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> </td>
<td class="paramname"> <em>fullproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kclangc_8h.html#ab81f0ec8b8a935f708fa60faadea86b2">KCVISITEMPTY</a> </td>
<td class="paramname"> <em>emptyproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>opq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>writable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a visitor to a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fullproc</em> </td><td>a call back function to visit a record. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>emptyproc</em> </td><td>a call back function to visit an empty record space. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer to be given to the call back functions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the operation for each record is performed atomically and other threads accessing the same record are blocked. </dd></dl>
</div>
</div>
<a class="anchor" id="a01828d3ba1b4e624683faea5311cfac0"></a><!-- doxytag: member="kclangc.h::kcdbiterate" ref="a01828d3ba1b4e624683faea5311cfac0" args="(KCDB *db, KCVISITFULL fullproc, void *opq, int32_t writable)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbiterate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> </td>
<td class="paramname"> <em>fullproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>opq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>writable</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate to accept a visitor for each record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fullproc</em> </td><td>a call back function to visit a record. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer to be given to the call back function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>the whole iteration is performed atomically and other threads are blocked. </dd></dl>
</div>
</div>
<a class="anchor" id="acc94df95a0d8863c450a649bdc546eaf"></a><!-- doxytag: member="kclangc.h::kcdbset" ref="acc94df95a0d8863c450a649bdc546eaf" args="(KCDB *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, a new record is created. If the corresponding record exists, the value is overwritten. </dd></dl>
</div>
</div>
<a class="anchor" id="a73fe31f31713e4951c3b4392d1c0d818"></a><!-- doxytag: member="kclangc.h::kcdbadd" ref="a73fe31f31713e4951c3b4392d1c0d818" args="(KCDB *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbadd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, a new record is created. If the corresponding record exists, the record is not modified and false is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="a14738a439d37fa7ea3d60a1a677834c8"></a><!-- doxytag: member="kclangc.h::kcdbreplace" ref="a14738a439d37fa7ea3d60a1a677834c8" args="(KCDB *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbreplace </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Replace the value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, no new record is created and false is returned. If the corresponding record exists, the value is modified. </dd></dl>
</div>
</div>
<a class="anchor" id="a2c2b464eedd23c73690ef6824206aded"></a><!-- doxytag: member="kclangc.h::kcdbappend" ref="a2c2b464eedd23c73690ef6824206aded" args="(KCDB *db, const char *kbuf, size_t ksiz, const char *vbuf, size_t vsiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbappend </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Append the value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, a new record is created. If the corresponding record exists, the given value is appended at the end of the existing value. </dd></dl>
</div>
</div>
<a class="anchor" id="aa56aefce671acb4f4144a17776182d3f"></a><!-- doxytag: member="kclangc.h::kcdbincrint" ref="aa56aefce671acb4f4144a17776182d3f" args="(KCDB *db, const char *kbuf, size_t ksiz, int64_t num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcdbincrint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>num</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a number to the numeric value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>the additional number. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the result value, or INT64_MIN on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="aceb58a120d0ecf01d0eaebea514a8680"></a><!-- doxytag: member="kclangc.h::kcdbincrdouble" ref="aceb58a120d0ecf01d0eaebea514a8680" args="(KCDB *db, const char *kbuf, size_t ksiz, double num)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double kcdbincrdouble </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>num</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add a number to the numeric value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>the additional number. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the result value, or Not-a-number on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="aed4df56efddad19e03ccf6c6ea329e6c"></a><!-- doxytag: member="kclangc.h::kcdbcas" ref="aed4df56efddad19e03ccf6c6ea329e6c" args="(KCDB *db, const char *kbuf, size_t ksiz, const char *nvbuf, size_t nvsiz, const char *ovbuf, size_t ovsiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbcas </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>nvbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>nvsiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>ovbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ovsiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform compare-and-swap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ovbuf</em> </td><td>the pointer to the old value region. NULL means that no record corresponds. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ovsiz</em> </td><td>the size of the old value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nvbuf</em> </td><td>the pointer to the new value region. NULL means that the record is removed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nvsiz</em> </td><td>the size of new old value region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="aec78ac6dc641edb8f5dd74370f4010a6"></a><!-- doxytag: member="kclangc.h::kcdbremove" ref="aec78ac6dc641edb8f5dd74370f4010a6" args="(KCDB *db, const char *kbuf, size_t ksiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbremove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, false is returned. </dd></dl>
</div>
</div>
<a class="anchor" id="ab552d20a2af1375b24aba34f412302d0"></a><!-- doxytag: member="kclangc.h::kcdbget" ref="ab552d20a2af1375b24aba34f412302d0" args="(KCDB *db, const char *kbuf, size_t ksiz, size_t *sp)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kcdbget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the value region of the corresponding record, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, NULL is returned. Because an additional zero code is appended at the end of the region of the return value, the return value can be treated as a C-style string. The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="ac383a4611e359530c28d746d52112219"></a><!-- doxytag: member="kclangc.h::kcdbgetbuf" ref="ac383a4611e359530c28d746d52112219" args="(KCDB *db, const char *kbuf, size_t ksiz, char *vbuf, size_t max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbgetbuf </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the value of a record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the buffer into which the value of the corresponding record is written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>the size of the buffer. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the size of the value, or -1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a853dea5181512c82535be1c0e32f765f"></a><!-- doxytag: member="kclangc.h::kcdbclear" ref="a853dea5181512c82535be1c0e32f765f" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbclear </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all records. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a8013c2ac28dcbde074cd2aa9a58aa72f"></a><!-- doxytag: member="kclangc.h::kcdbsync" ref="a8013c2ac28dcbde074cd2aa9a58aa72f" args="(KCDB *db, int32_t hard, KCFILEPROC proc, void *opq)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>hard</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kclangc_8h.html#a55e9f27415a9ee1d641cef35cc518b8f">KCFILEPROC</a> </td>
<td class="paramname"> <em>proc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>opq</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Synchronize updated contents with the file and the device. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>proc</em> </td><td>a postprocessor call back function. If it is NULL, no postprocessing is performed. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer to be given to the call back function. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a9876214275221936d62b620f49b34570"></a><!-- doxytag: member="kclangc.h::kcdbcopy" ref="a9876214275221936d62b620f49b34570" args="(KCDB *db, const char *dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbcopy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a copy of the database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the path of the destination file. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a531f94f519cd35a5fc7bc1e0ef04ece8"></a><!-- doxytag: member="kclangc.h::kcdbbegintran" ref="a531f94f519cd35a5fc7bc1e0ef04ece8" args="(KCDB *db, int32_t hard)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbbegintran </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>hard</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Begin transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="af00b9f2ed98722be9399d492e6c33a64"></a><!-- doxytag: member="kclangc.h::kcdbbegintrantry" ref="af00b9f2ed98722be9399d492e6c33a64" args="(KCDB *db, int32_t hard)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbbegintrantry </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>hard</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Try to begin transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>hard</em> </td><td>true for physical synchronization with the device, or false for logical synchronization with the file system. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a288565a6579bc9125390c752be829804"></a><!-- doxytag: member="kclangc.h::kcdbendtran" ref="a288565a6579bc9125390c752be829804" args="(KCDB *db, int32_t commit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbendtran </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>commit</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End transaction. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>commit</em> </td><td>true to commit the transaction, or false to abort the transaction. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="ad2b07256a5236ba981be4a863ada8e43"></a><!-- doxytag: member="kclangc.h::kcdbdumpsnap" ref="ad2b07256a5236ba981be4a863ada8e43" args="(KCDB *db, const char *dest)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbdumpsnap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>dest</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Dump records into a file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the path of the destination file. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="af283ad00d5f46edd883356a4b3f9e979"></a><!-- doxytag: member="kclangc.h::kcdbloadsnap" ref="af283ad00d5f46edd883356a4b3f9e979" args="(KCDB *db, const char *src)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbloadsnap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>src</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Load records from a file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>src</em> </td><td>the path of the source file. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="afa5d9b2da776853efae3abb20ad562c4"></a><!-- doxytag: member="kclangc.h::kcdbcount" ref="afa5d9b2da776853efae3abb20ad562c4" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcdbcount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the number of records. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of records, or -1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a278ea62b6ba5c9cabeadc77a1cde213c"></a><!-- doxytag: member="kclangc.h::kcdbsize" ref="a278ea62b6ba5c9cabeadc77a1cde213c" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcdbsize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the size of the database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the size of the database file in bytes, or -1 on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a87de7082c3f19fd255b431f0ccb92f44"></a><!-- doxytag: member="kclangc.h::kcdbpath" ref="a87de7082c3f19fd255b431f0ccb92f44" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kcdbpath </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the path of the database file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the path of the database file, or an empty string on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a156561acce1ad4f2db9c00f1b5c01e7b"></a><!-- doxytag: member="kclangc.h::kcdbstatus" ref="a156561acce1ad4f2db9c00f1b5c01e7b" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kcdbstatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the miscellaneous status information. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the result string of tab saparated values, or NULL on failure. Each line consists of the attribute name and its value separated by a tab character. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="ad5c2697cda42ae1ddda0232124add786"></a><!-- doxytag: member="kclangc.h::kcdbmatchprefix" ref="ad5c2697cda42ae1ddda0232124add786" args="(KCDB *db, const char *prefix, char **strary, int64_t max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcdbmatchprefix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>strary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get keys matching a prefix string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>the prefix string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>strary</em> </td><td>an array to contain the result. Its size must be sufficient. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>the maximum number to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of retrieved keys or -1 on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The region of each element of the result should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a896e2c260e06f135d33af4df75c72e49"></a><!-- doxytag: member="kclangc.h::kcdbmatchregex" ref="a896e2c260e06f135d33af4df75c72e49" args="(KCDB *db, const char *regex, char **strary, int64_t max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t kcdbmatchregex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>regex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>strary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int64_t </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get keys matching a regular expression string. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>regex</em> </td><td>the regular expression string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>strary</em> </td><td>an array to contain the result. Its size must be sufficient. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>the maximum number to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the number of retrieved keys or -1 on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The region of each element of the result should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a20e630cadb0b3518c13c9ca6cff60aed"></a><!-- doxytag: member="kclangc.h::kcdbmerge" ref="a20e630cadb0b3518c13c9ca6cff60aed" args="(KCDB *db, KCDB **srcary, size_t srcnum, uint32_t mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kcdbmerge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> ** </td>
<td class="paramname"> <em>srcary</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>srcnum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>mode</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Merge records from other databases. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcary</em> </td><td>an array of the source detabase objects. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>srcnum</em> </td><td>the number of the elements of the source array. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>the merge mode. KCMSET to overwrite the existing value, KCMADD to keep the existing value, KCMREPLACE to modify the existing record only, KCMAPPEND to append the new value. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="adccaf4771f7804511791af33a316e0ba"></a><!-- doxytag: member="kclangc.h::kcdbcursor" ref="adccaf4771f7804511791af33a316e0ba" args="(KCDB *db)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionKCCUR.html">KCCUR</a>* kcdbcursor </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCDB.html">KCDB</a> * </td>
<td class="paramname"> <em>db</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a cursor object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>a database object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the return value is the created cursor object. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>The object of the return value should be released with the kccurdel function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a88d85075827598fa94c6fd4c3430389f"></a><!-- doxytag: member="kclangc.h::kccurdel" ref="a88d85075827598fa94c6fd4c3430389f" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void kccurdel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a cursor object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>the cursor object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7ca1819141a1554397bbfede6d6f325e"></a><!-- doxytag: member="kclangc.h::kccuraccept" ref="a7ca1819141a1554397bbfede6d6f325e" args="(KCCUR *cur, KCVISITFULL fullproc, void *opq, int32_t writable, int32_t step)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccuraccept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="kclangc_8h.html#ad5322730d6c138c6c32bd501fc2c09e3">KCVISITFULL</a> </td>
<td class="paramname"> <em>fullproc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>opq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>writable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Accept a visitor to the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fullproc</em> </td><td>a call back function to visit a record. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>opq</em> </td><td>an opaque pointer to be given to the call back functions. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>writable</em> </td><td>true for writable operation, or false for read-only operation. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="abf07e20809ce5927f81ed055e0c8c637"></a><!-- doxytag: member="kclangc.h::kccursetvalue" ref="abf07e20809ce5927f81ed055e0c8c637" args="(KCCUR *cur, const char *vbuf, size_t vsiz, int32_t step)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccursetvalue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>vbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>vsiz</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the value of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbuf</em> </td><td>the pointer to the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsiz</em> </td><td>the size of the value region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a0867dbd783e2a23c1a6be653d8e41bdd"></a><!-- doxytag: member="kclangc.h::kccurremove" ref="a0867dbd783e2a23c1a6be653d8e41bdd" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurremove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If no record corresponds to the key, false is returned. The cursor is moved to the next record implicitly. </dd></dl>
</div>
</div>
<a class="anchor" id="a1f15ef59f87b34eeeb4374c847d67b4b"></a><!-- doxytag: member="kclangc.h::kccurgetkey" ref="a1f15ef59f87b34eeeb4374c847d67b4b" args="(KCCUR *cur, size_t *sp, int32_t step)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kccurgetkey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the key of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the key region of the current record, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If the cursor is invalidated, NULL is returned. Because an additional zero code is appended at the end of the region of the return value, the return value can be treated as a C-style string. The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a5ebbb378e935cd773107503d7d4d466c"></a><!-- doxytag: member="kclangc.h::kccurgetvalue" ref="a5ebbb378e935cd773107503d7d4d466c" args="(KCCUR *cur, size_t *sp, int32_t step)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kccurgetvalue </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>sp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the value region of the current record, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If the cursor is invalidated, NULL is returned. Because an additional zero code is appended at the end of the region of the return value, the return value can be treated as a C-style string. The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a543b0095fb011f3ae42424460190d25a"></a><!-- doxytag: member="kclangc.h::kccurget" ref="a543b0095fb011f3ae42424460190d25a" args="(KCCUR *cur, size_t *ksp, const char **vbp, size_t *vsp, int32_t step)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* kccurget </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>ksp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char ** </td>
<td class="paramname"> <em>vbp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t * </td>
<td class="paramname"> <em>vsp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t </td>
<td class="paramname"> <em>step</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pair of the key and the value of the current record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksp</em> </td><td>the pointer to the variable into which the size of the region of the return value is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vbp</em> </td><td>the pointer to the variable into which the pointer to the value region is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>vsp</em> </td><td>the pointer to the variable into which the size of the value region is assigned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>true to move the cursor to the next record, or false for no move. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the pair of the key region, or NULL on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>If the cursor is invalidated, NULL is returned. Because an additional zero code is appended at the end of each region of the key and the value, each region can be treated as a C-style string. The region of the return value should be released with the kcfree function when it is no longer in use. </dd></dl>
</div>
</div>
<a class="anchor" id="a086c2e825133e414430ebd9fa010c9e0"></a><!-- doxytag: member="kclangc.h::kccurjump" ref="a086c2e825133e414430ebd9fa010c9e0" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurjump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to the first record for forward scan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="a6b02b505678f971be270e3ba9a1b4d76"></a><!-- doxytag: member="kclangc.h::kccurjumpkey" ref="a6b02b505678f971be270e3ba9a1b4d76" args="(KCCUR *cur, const char *kbuf, size_t ksiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurjumpkey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for forward scan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="aea97152d108e403d57d6de9b9b9c905c"></a><!-- doxytag: member="kclangc.h::kccurjumpback" ref="aea97152d108e403d57d6de9b9b9c905c" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurjumpback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to the last record for backward scan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, may provide a dummy implementation. </dd></dl>
</div>
</div>
<a class="anchor" id="a6a64ab5f495da06c7361f010caa9371a"></a><!-- doxytag: member="kclangc.h::kccurjumpbackkey" ref="a6a64ab5f495da06c7361f010caa9371a" args="(KCCUR *cur, const char *kbuf, size_t ksiz)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurjumpbackkey </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>kbuf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>ksiz</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Jump the cursor to a record for backward scan. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>kbuf</em> </td><td>the pointer to the key region. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ksiz</em> </td><td>the size of the key region. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, will provide a dummy implementation. </dd></dl>
</div>
</div>
<a class="anchor" id="a8eb7192456824eaad2e15444704e9055"></a><!-- doxytag: member="kclangc.h::kccurstep" ref="a8eb7192456824eaad2e15444704e9055" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurstep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step the cursor to the next record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
</div>
</div>
<a class="anchor" id="afeb16bd9461ab3f5dc2d21fa3ba28213"></a><!-- doxytag: member="kclangc.h::kccurstepback" ref="afeb16bd9461ab3f5dc2d21fa3ba28213" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurstepback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Step the cursor to the previous record. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, or false on failure. </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>This method is dedicated to tree databases. Some database types, especially hash databases, may provide a dummy implementation. </dd></dl>
</div>
</div>
<a class="anchor" id="a20a80ae0156692ad33cd0b8bfcf7eeab"></a><!-- doxytag: member="kclangc.h::kccurdb" ref="a20a80ae0156692ad33cd0b8bfcf7eeab" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionKCDB.html">KCDB</a>* kccurdb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the database object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the database object. </dd></dl>
</div>
</div>
<a class="anchor" id="a479ed6830ab7fb85b146bff54f67df23"></a><!-- doxytag: member="kclangc.h::kccurecode" ref="a479ed6830ab7fb85b146bff54f67df23" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t kccurecode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the code of the last happened error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the code of the last happened error. </dd></dl>
</div>
</div>
<a class="anchor" id="a46daaae1cd681d037e3f45fb6028f03c"></a><!-- doxytag: member="kclangc.h::kccuremsg" ref="a46daaae1cd681d037e3f45fb6028f03c" args="(KCCUR *cur)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* kccuremsg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionKCCUR.html">KCCUR</a> * </td>
<td class="paramname"> <em>cur</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the supplement message of the last happened error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cur</em> </td><td>a cursor object. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the supplement message of the last happened error. </dd></dl>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a2b538a7a564d0fbd9fe92d9877b4bcb0"></a><!-- doxytag: member="kclangc.h::KCVERSION" ref="a2b538a7a564d0fbd9fe92d9877b4bcb0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="kclangc_8h.html#a2b538a7a564d0fbd9fe92d9877b4bcb0">KCVERSION</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The package version. </p>
</div>
</div>
<a class="anchor" id="a64c59ac34c88a862d2066d9097b09504"></a><!-- doxytag: member="kclangc.h::KCVISNOP" ref="a64c59ac34c88a862d2066d9097b09504" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="kclangc_8h.html#a64c59ac34c88a862d2066d9097b09504">KCVISNOP</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Special pointer for no operation by the visiting function. </p>
</div>
</div>
<a class="anchor" id="a8db7ac3c4e7d52ee1106a527a1bae0c8"></a><!-- doxytag: member="kclangc.h::KCVISREMOVE" ref="a8db7ac3c4e7d52ee1106a527a1bae0c8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* const <a class="el" href="kclangc_8h.html#a8db7ac3c4e7d52ee1106a527a1bae0c8">KCVISREMOVE</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Special pointer to remove the record by the visiting function. </p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jan 3 13:02:27 2011 for Kyoto Cabinet by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
