[27221] in CVS-changelog-for-Kerberos-V5
krb5 commit [krb5-1.11]: Correctly document krb5_unparse_name_ext
daemon@ATHENA.MIT.EDU (Tom Yu)
Tue Oct 30 14:04:35 2012
Date: Tue, 30 Oct 2012 14:02:24 -0400
From: Tom Yu <tlyu@mit.edu>
Message-Id: <201210301802.q9UI2O5D001056@drugstore.mit.edu>
To: cvs-krb5@mit.edu
Reply-To: krbdev@mit.edu
MIME-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: cvs-krb5-bounces@mit.edu
https://github.com/krb5/krb5/commit/b154df500218222b00028181fdf439cbc8c5326c
commit b154df500218222b00028181fdf439cbc8c5326c
Author: Greg Hudson <ghudson@mit.edu>
Date: Thu Oct 25 15:50:06 2012 -0400
Correctly document krb5_unparse_name_ext
(cherry picked from commit 671c84a37521a4f62be300af00790fc5aed9cbfd)
ticket: 7431
version_fixed: 1.11
status: resolved
src/include/krb5/krb5.hin | 20 +++++++++++++-------
1 files changed, 13 insertions(+), 7 deletions(-)
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index dd2b85b..7db3787 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -3507,13 +3507,19 @@ krb5_unparse_name(krb5_context context, krb5_const_principal principal,
/**
* Convert krb5_principal structure to string and length.
*
- * @param [in] context Library context
- * @param [in] principal Principal
- * @param [out] name String representation of principal name
- * @param [out] size Size of unparsed name
- *
- * This function is similar to krb5_unparse_name(), but also returns the length
- * of the string representation.
+ * @param [in] context Library context
+ * @param [in] principal Principal
+ * @param [in,out] name String representation of principal name
+ * @param [in,out] size Size of unparsed name
+ *
+ * This function is similar to krb5_unparse_name(), but allows the use of an
+ * existing buffer for the result. If size is not NULL, then *name must be
+ * either NULL or an existing buffer of at least size *size. The buffer will
+ * be allocated or resized if necessary, with the new pointer stored into
+ * *name. Whether or not the buffer is resized, the necessary space for the
+ * result, including null terminator, will be stored into *size.
+ *
+ * If size is NULL, this function behaves exactly as krb5_unparse_name().
*
* @retval
* 0 Success
_______________________________________________
cvs-krb5 mailing list
cvs-krb5@mit.edu
https://mailman.mit.edu/mailman/listinfo/cvs-krb5
