document gss_release_name
authorLove Hornquist Astrand <lha@h5l.org>
Sun, 21 Feb 2010 22:21:43 +0000 (23:21 +0100)
committerLove Hornquist Astrand <lha@h5l.org>
Sun, 21 Feb 2010 22:21:43 +0000 (23:21 +0100)
lib/gssapi/mech/gss_release_name.c

index 84553ee05d0c7e50f1c2ec5a7bb6ee6d4f8b487c..47786725acc7513e7a97708d0f2df3bedbad8fba 100644 (file)
 
 #include "mech_locl.h"
 
+/**
+ * Free a name
+ *
+ * import_name can point to NULL or be NULL, or a pointer to a
+ * gss_name_t structure. If it was a pointer to gss_name_t, the
+ * pointer will be set to NULL on success and failure.
+ *
+ * @param minor_status minor status code
+ * @param input_name name to free
+ *
+ * @returns a gss_error code, see gss_display_status() about printing
+ *        the error code.
+ *  
+ * @ingroup gssapi
+ */
 OM_uint32 GSSAPI_LIB_FUNCTION
 gss_release_name(OM_uint32 *minor_status,
     gss_name_t *input_name)