dect/asterisk
Archived
14
0
Fork 0
Code Releases Activity

Merged revisions 302680 via svnmerge from

Browse source 
https://origsvn.digium.com/svn/asterisk/branches/1.8

................
  r302680 | tilghman | 2011-01-19 15:23:31 -0600 (Wed, 19 Jan 2011) | 16 lines
  
  Merged revisions 302675 via svnmerge from 
  https://origsvn.digium.com/svn/asterisk/branches/1.6.2
  
  ................
    r302675 | tilghman | 2011-01-19 15:22:45 -0600 (Wed, 19 Jan 2011) | 9 lines
    
    Merged revisions 302663 via svnmerge from 
    https://origsvn.digium.com/svn/asterisk/branches/1.4
    
    ........
      r302663 | tilghman | 2011-01-19 15:20:28 -0600 (Wed, 19 Jan 2011) | 2 lines
      
      Add some API documentation
    ........
  ................
................


git-svn-id: http://svn.digium.com/svn/asterisk/trunk@302686 f38db490-d61c-443f-a65b-d21fe96a405b
This commit is contained in:
tilghman 2011-01-19 21:24:25 +00:00
parent c9aff74ec3
commit 5ed8645f7d
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
include/asterisk/astdb.h
View file

@ -33,22 +33,37 @@ struct ast_db_entry {
char data[0];
};
/*! \brief Get key value specified by family/key */
/*!\brief Get key value specified by family/key */
int ast_db_get(const char *family, const char *key, char *out, int outlen);
/*! \brief Store value addressed by family/key*/
/*!\brief Store value addressed by family/key */
int ast_db_put(const char *family, const char *key, const char *value);
/*! \brief Delete entry in astdb */
/*!\brief Delete entry in astdb */
int ast_db_del(const char *family, const char *key);
/*! \brief Delete a whole family (for some reason also called "tree" */
/*!\brief Delete one or more entries in astdb
* If both parameters are NULL, the entire database will be purged. If
* only keytree is NULL, all entries within the family will be purged.
* It is an error for keytree to have a value when family is NULL.
*
* \retval 0 Entries were deleted
* \retval -1 An error occurred
*/
int ast_db_deltree(const char *family, const char *keytree);
/*! \brief Get a whole family */
/*!\brief Get a list of values within the astdb tree
* If family is specified, only those keys will be returned. If keytree
* is specified, subkeys are expected to exist (separated from the key with
* a slash). If subkeys do not exist and keytree is specified, the tree will
* consist of either a single entry or NULL will be returned.
*
* Resulting tree should be freed by passing the return value to ast_db_freetree()
* when usage is concluded.
*/
struct ast_db_entry *ast_db_gettree(const char *family, const char *keytree);
/*! \brief Free in-memory data */
/*!\brief Free structure created by ast_db_gettree() */
void ast_db_freetree(struct ast_db_entry *entry);
#if defined(__cplusplus) || defined(c_plusplus)