aboutsummaryrefslogtreecommitdiff
path: root/src/include/krb5
diff options
context:
space:
mode:
authorSarah Day <sarahday@mit.edu>2015-12-11 11:46:04 -0500
committerGreg Hudson <ghudson@mit.edu>2016-03-24 11:08:19 -0400
commit4d02def02a172bdfc5c5c2c9059cef559d8c1feb (patch)
tree371ba47a97cecfd263702a3b09be8fc7f91bf07d /src/include/krb5
parente88be3da7738ad2c03c4a6d0c78b44dd09f78fa8 (diff)
downloadkrb5-4d02def02a172bdfc5c5c2c9059cef559d8c1feb.zip
krb5-4d02def02a172bdfc5c5c2c9059cef559d8c1feb.tar.gz
krb5-4d02def02a172bdfc5c5c2c9059cef559d8c1feb.tar.bz2
Add documentation for krb5_error_code
ticket: 8387 (new) target_version: 1.14-next tags: pullup
Diffstat (limited to 'src/include/krb5')
-rw-r--r--src/include/krb5/krb5.hin8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 9e91a60..c045ee3 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 {