oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

document hdb__ functions.

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@25083 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2009-04-03 17:45:01 +00:00
parent 4abf5ab6ef
commit e6b3f6f796
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
lib/hdb/hdb.h
View File

@@ -150,16 +150,28 @@ typedef struct HDB{
*/ */
krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*); krb5_error_code (*hdb_rename)(krb5_context, struct HDB*, const char*);
/** /**
* Get a encoded principal from database. * Get an hdb_entry from a classical DB backend
* *
* If the database is a pure DB backend, this function will take a * If the database is a classical DB (ie BDB, NDBM, GDBM, etc)
* principal key and return all data related to principal. The * backend, this function will take a principal key (krb5_data)
* encoded entry is of type hdb_entry or hdb_entry_alias. * and return all data related to principal in the return
* krb5_data. The returned encoded entry is of type hdb_entry or
* hdb_entry_alias.
*/ */
krb5_error_code (*hdb__get)(krb5_context, struct HDB*, krb5_error_code (*hdb__get)(krb5_context, struct HDB*,
krb5_data, krb5_data*); krb5_data, krb5_data*);
/**
* Store an hdb_entry from a classical DB backend
*
* Same discussion as in @ref HDB::hdb__get
*/
krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int, krb5_error_code (*hdb__put)(krb5_context, struct HDB*, int,
krb5_data, krb5_data); krb5_data, krb5_data);
/**
* Delete and hdb_entry from a classical DB backend
*
* Same discussion as in @ref HDB::hdb__get
*/
krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data); krb5_error_code (*hdb__del)(krb5_context, struct HDB*, krb5_data);
/** /**
* Destroy the handle to the database. * Destroy the handle to the database.