aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Kaduk <kaduk@mit.edu>2014-06-11 16:38:57 -0400
committerTom Yu <tlyu@mit.edu>2016-10-24 15:38:13 -0400
commit3cac667399ebce50985242f792526455ce59ae0d (patch)
tree3d4ae58116c1f67988afa0efaf0801c63ba9ff55
parentb5cd94af456bd62a0f71c5bf88dd6a74b5671653 (diff)
downloadkrb5-3cac667399ebce50985242f792526455ce59ae0d.zip
krb5-3cac667399ebce50985242f792526455ce59ae0d.tar.gz
krb5-3cac667399ebce50985242f792526455ce59ae0d.tar.bz2
Document krb5_kt_next_entry() requirement
Successful calls to krb5_kt_next_entry() return a krb5_keytab_entry that the caller is responsible for freeing. Note this, and the proper function to do so, in the doxygen comments. (cherry picked from commit e70c73b804400a2f18a044dd386dbf1a8430b92e) ticket: 8500 version_fixed: 1.14.5
-rw-r--r--src/include/krb5/krb5.hin1
1 files changed, 1 insertions, 0 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index e2c08ae..bac076a 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2899,6 +2899,7 @@ krb5_kt_start_seq_get(krb5_context context, krb5_keytab keytab,
* @param [in] cursor Key table cursor
*
* Return the next sequential entry in @a keytab and advance @a cursor.
+ * Callers must release the returned entry with krb5_kt_free_entry().
*
* @sa krb5_kt_start_seq_get(), krb5_kt_end_seq_get()
*