diff options
author | Nancy Gilman <nlgilman@mit.edu> | 1994-06-14 19:09:21 +0000 |
---|---|---|
committer | Nancy Gilman <nlgilman@mit.edu> | 1994-06-14 19:09:21 +0000 |
commit | c0af96f6e06ebf68e770053083f8165ec755da79 (patch) | |
tree | c9c299df186af07693f9e1d6c4b1634e524fc736 /doc/implement/kdb-i.tex | |
parent | 1675ef2c7904720a973a3fd62a7181162f482cd7 (diff) | |
download | krb5-c0af96f6e06ebf68e770053083f8165ec755da79.zip krb5-c0af96f6e06ebf68e770053083f8165ec755da79.tar.gz krb5-c0af96f6e06ebf68e770053083f8165ec755da79.tar.bz2 |
The first revision after the creation of the
implementor's guide
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@3771 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/implement/kdb-i.tex')
-rw-r--r-- | doc/implement/kdb-i.tex | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/implement/kdb-i.tex b/doc/implement/kdb-i.tex index fb9ac80..dc81971 100644 --- a/doc/implement/kdb-i.tex +++ b/doc/implement/kdb-i.tex @@ -7,8 +7,8 @@ manipulation tools. \funcarg{char *}{name} \end{funcdecl} -Set the name of the database to \funcparam{name}. If it doesn't exist, -an error code is returned. +Set the name of the database to \funcparam{name}. +%Errors: If it doesn't exist, an error code is returned. Must be called before \funcname{krb5_db_init} or after \funcname{krb5_db_fini}; must not be called while db functions are active. @@ -40,7 +40,7 @@ Called before using \funcname{krb5_db_get_principal}, Does any required initialization. -Errors: init errors, system errors. +%Errors: init errors, system errors. \begin{funcdecl}{krb5_db_fini}{krb5_error_code}{\funcvoid} \end{funcdecl} @@ -48,7 +48,7 @@ Errors: init errors, system errors. Called after all database operations are complete, to perform any required clean-up. -Errors: sysytem errors. +%Errors: sysytem errors. \begin{funcdecl}{krb5_db_get_age}{krb5_error_code}{\funcin} @@ -63,7 +63,7 @@ default database if \funcname{db_name} is NULL). \funcparam{*age} is filled in in local system time units, and represents the last modification time of the database. -Errors: system errors. +%Errors: system errors. \begin{funcdecl}{krb5_db_create}{krb5_error_code}{\funcin} @@ -74,7 +74,7 @@ Creates a new database named \funcname{db_name}. Will not create a database by that name if it already exists. The database must be populated by the caller by using \funcname{krb5_db_put_principal}. -Errors: db exists, system errors. +%Errors: db exists, system errors. \begin{funcdecl}{krb5_db_rename}{krb5_error_code}{\funcin} \funcarg{char *}{source} @@ -84,7 +84,7 @@ Renames the database \funcarg{source} to \funcarg{dest} Any database named \funcarg{dest} is destroyed. -Errors: system errors. +%Errors: system errors. \begin{funcdecl}{krb5_db_get_principal}{krb5_error_code}{\funcin} \funcarg{krb5_principal}{searchfor} @@ -135,7 +135,7 @@ Stores the \funcparam{*nentries} principal structures pointed to by acutally stored; the first \funcparam{*nentries} records will have been stored in the database. -Returns error code if not all entries were stored. +%Errors: Returns error code if not all entries were stored. \begin{funcdecl}{krb5_db_iterate}{krb5_error_code}{\funcin} \funcfuncarg{krb5_error_code}{(*func)} @@ -150,7 +150,8 @@ and calling \funcparam{(*func)}(\funcparam{iterate_arg}, \funcparam{principal}) where \funcparam{principal} points to a record from the database. -If \funcparam{(*func)}() ever returns an error code, the iteration is +If \funcparam{(*func)}() ever returns an error code, the iteration +should be aborted and that error code is returned by this function. \begin{funcdecl}{krb5_db_store_mkey}{krb5_error_code}{\funcin} |