From: Sarah Day <sarahday@mit.edu>
Date: Fri, 11 Dec 2015 16:46:04 +0000 (-0500)
Subject: Add documentation for krb5_error_code
X-Git-Tag: krb5-1.15-beta1~234
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4d02def02a172bdfc5c5c2c9059cef559d8c1feb;p=thirdparty%2Fkrb5.git

Add documentation for krb5_error_code

ticket: 8387 (new)
target_version: 1.14-next
tags: pullup
---

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 9e91a60d2c..c045ee3770 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -182,9 +182,15 @@ typedef krb5_int32 krb5_cryptotype;
 typedef krb5_int32      krb5_preauthtype; /* This may change, later on */
 typedef krb5_int32      krb5_flags;
 typedef krb5_int32      krb5_timestamp;
-typedef krb5_int32      krb5_error_code;
 typedef krb5_int32      krb5_deltat;
 
+/**
+ * Used to convey an operation status.  The value 0 indicates success; any
+ * other values are com_err codes.  Use krb5_get_error_message() to obtain a
+ * string describing the error.
+ */
+typedef krb5_int32      krb5_error_code;
+
 typedef krb5_error_code krb5_magic;
 
 typedef struct _krb5_data {