Updated the documentation for the krb5_ error_message function family.

Created the directory  doc/doxy_examples/ to hold examples used in the doxygen documentation.
Added usage example for the krb5_get/set/free_error_message functions

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24752 dc483132-0cff-0310-8789-dd5450dbe970

1 files changed, 20 insertions, 0 deletions

diff --git a/doc/doxy_examples/error_message.c b/doc/doxy_examples/error_message.c
new file mode 100755
index 0000000000..1e1569760f
--- /dev/null
+++ b/doc/doxy_examples/error_message.c
@@ -0,0 +1,20 @@
+/** @example  error_message.c
+ *
+ *  Demo for krb5_get/set/free_error_message function family
+ */
+#include <k5-int.h>
+
+krb5_error_code
+func(krb5_context context)
+{
+    krb5_error_code ret;
+
+    ret = krb5_func(context);
+    if (ret) {
+        const char *err_str = krb5_get_error_message(context, ret);
+        krb5_set_error_message(context, ret,
+                               "Failed krb5_func: %s", err_str);
+        krb5_free_error_message(context, err_str);
+    }
+}
+