oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

doxygenify

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@22549 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2008-01-29 09:37:25 +00:00
parent ce8c0da847
commit 52d38ed2ad
1 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
lib/krb5/principal.c
View File

@@ -31,6 +31,22 @@
* SUCH DAMAGE. * SUCH DAMAGE.
*/ */
/**
* @page page_principal The principal handing functions.
*
* A Kerberos principal is a email address looking string that
* contains to parts separeted by a @. The later part is the kerbero
* realm the principal belongs to and the former is a list of 0 or
* more components. For example
* @verbatim
lha@SU.SE
host/hummel.it.su.se@SU.SE
host/admin@H5L.ORG
@endverbatim
*
* See the library functions here: @ref krb5_principal
*/
#include "krb5_locl.h" #include "krb5_locl.h"
#ifdef HAVE_RES_SEARCH #ifdef HAVE_RES_SEARCH
#define USE_RESOLVER #define USE_RESOLVER
@@ -49,6 +65,21 @@ RCSID("$Id$");
#define princ_ncomp(P, N) ((P)->name.name_string.val[(N)]) #define princ_ncomp(P, N) ((P)->name.name_string.val[(N)])
#define princ_realm(P) ((P)->realm) #define princ_realm(P) ((P)->realm)
/**
* Frees a Kerberos principal allocated by the library with
* krb5_parse_name(), krb5_make_principal() or any other related
* principal functions.
*
* @param context A Kerberos context.
* @param p a principal to free.
*
* @return An krb5 error code, see krb5_get_error_message().
*
* @ingroup krb5_principal
*/
void KRB5_LIB_FUNCTION void KRB5_LIB_FUNCTION
krb5_free_principal(krb5_context context, krb5_free_principal(krb5_context context,
krb5_principal p) krb5_principal p)