diff options
author | Nancy Gilman <nlgilman@mit.edu> | 1994-01-13 01:53:28 +0000 |
---|---|---|
committer | Nancy Gilman <nlgilman@mit.edu> | 1994-01-13 01:53:28 +0000 |
commit | 1b627b36caf3e1d5d7a7968c4008f56f2e82ae8e (patch) | |
tree | f968cfae77131a47e1a9f66ac4b4d2a36c997e2f /doc/api | |
parent | 81ae975106c242b241524a024cf8d27f5118dae7 (diff) | |
download | krb5-1b627b36caf3e1d5d7a7968c4008f56f2e82ae8e.tar.gz krb5-1b627b36caf3e1d5d7a7968c4008f56f2e82ae8e.tar.xz krb5-1b627b36caf3e1d5d7a7968c4008f56f2e82ae8e.zip |
nlg- updated based on function prototypes
arguments should now be correct
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@3305 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/ccache.tex | 25 | ||||
-rw-r--r-- | doc/api/keytab.tex | 4 |
2 files changed, 15 insertions, 14 deletions
diff --git a/doc/api/ccache.tex b/doc/api/ccache.tex index 83607af9b..983eb0d8b 100644 --- a/doc/api/ccache.tex +++ b/doc/api/ccache.tex @@ -20,7 +20,7 @@ Creates a credentials cache named by \funcparam{residual} (which may be interpreted differently by each type of ccache). The cache is not opened, but the cache name is held in reserve. -\begin{funcdecl}{krb5_cc_gennew_internal}{krb5_error_code}{\funcout} +\begin{funcdecl}{krb5_cc_gen_new_internal}{krb5_error_code}{\funcout} \funcarg{krb5_ccache *}{id} \end{funcdecl} @@ -59,16 +59,16 @@ Errors: permission errors. \funcarg{krb5_ccache}{id} \end{funcdecl} -Closes the credentials cache \funcparam{id}, invalidates \funcparam{id}, -and releases any other resources acquired during use of the credentials -cache. Requires that \funcparam{id} identifies a valid credentials -cache. After return, \funcparam{id} must not be used unless it is first -reinitialized. +Closes the credentials cache \funcparam{id}, invalidates +\funcparam{id}, and releases \funcparam{id} and any other resources +acquired during use of the credentials cache. Requires that +\funcparam{id} identifies a valid credentials cache. After return, +\funcparam{id} must not be used unless it is first reinitialized. \begin{funcdecl}{krb5_cc_store_cred}{krb5_error_code}{\funcin} \funcarg{krb5_ccache}{id} -\funcarg{krb5_credentials *}{creds} +\funcarg{krb5_creds *}{creds} \end{funcdecl} Stores \funcparam{creds} in the cache \funcparam{id}, tagged with @@ -80,9 +80,9 @@ Errors: permission errors, storage failure errors. \begin{funcdecl}{krb5_cc_retrieve_cred}{krb5_error_code}{\funcin} \funcarg{krb5_ccache}{id} \funcarg{krb5_flags}{whichfields} -\funcarg{krb5_credentials *}{mcreds} +\funcarg{krb5_creds *}{mcreds} \funcout -\funcarg{krb5_credentials *}{creds} +\funcarg{krb5_creds *}{creds} \end{funcdecl} Searches the cache \funcparam{id} for credentials matching @@ -92,7 +92,8 @@ name \funcparam{mcreds{\ptsto}server}. Requires that \funcparam{id} identifies a valid credentials cache. If at least one match is found, one of the matching credentials is -returned in \funcparam{*creds}. XXX free the return creds? +returned in \funcparam{*creds}. The credentials should be freed using +\funcname{krb5_free_credentials}. Errors: error code if no matches found. @@ -124,7 +125,7 @@ Requires that \funcparam{id} identifies a valid credentials cache opened by \begin{funcdecl}{krb5_cc_next_cred}{krb5_error_code}{\funcin} \funcarg{krb5_ccache}{id} \funcout -\funcarg{krb5_credentials *}{creds} +\funcarg{krb5_creds *}{creds} \funcinout \funcarg{krb5_cc_cursor *}{cursor} \end{funcdecl} @@ -157,7 +158,7 @@ Errors: may return error code if \funcparam{*cursor} is invalid. \begin{funcdecl}{krb5_cc_remove_cred}{krb5_error_code}{\funcin} \funcarg{krb5_ccache}{id} \funcarg{krb5_flags}{which} -\funcarg{krb5_credentials *}{cred} +\funcarg{krb5_creds *}{cred} \end{funcdecl} Removes any credentials from \funcparam{id} which match the principal diff --git a/doc/api/keytab.tex b/doc/api/keytab.tex index 4a45295c5..a10e40fd4 100644 --- a/doc/api/keytab.tex +++ b/doc/api/keytab.tex @@ -120,7 +120,7 @@ Errors: error code if no more cache entries or if the keytab changes. \begin{funcdecl}{krb5_kt_end_seq_get}{krb5_error_code}{\funcin} \funcarg{krb5_keytab}{id} -\funcarg{krb5_kt_cursor}{cursor} +\funcarg{krb5_kt_cursor *}{cursor} \end{funcdecl} Finishes sequential processing mode and invalidates \funcparam{cursor}, @@ -179,7 +179,7 @@ yet known. An error is returned if \funcparam{ops{\ptsto}prefix} is already known. \begin{funcdecl}{krb5_kt_resolve}{krb5_error_code}{\funcin} -\funcarg{char *}{string_name} +\funcarg{const char *}{string_name} \funcout \funcarg{krb5_keytab *}{id} \end{funcdecl} |