From 002cb3e65e91e87842a8b69d1c97c19423d1fb08 Mon Sep 17 00:00:00 2001 From: Alexandra Ellwood Date: Thu, 23 Aug 2007 16:53:53 +0000 Subject: Add documentation for CCAPI Added Doxygen-based documentation to CredentialsCache.h and checked in a copy of the html output of that documentation. ticket: new git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@19849 dc483132-0cff-0310-8789-dd5450dbe970 --- doc/ccapi/html/structcc__credentials__f.html | 67 ++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 doc/ccapi/html/structcc__credentials__f.html (limited to 'doc/ccapi/html/structcc__credentials__f.html') diff --git a/doc/ccapi/html/structcc__credentials__f.html b/doc/ccapi/html/structcc__credentials__f.html new file mode 100644 index 000000000..6f4bc74e1 --- /dev/null +++ b/doc/ccapi/html/structcc__credentials__f.html @@ -0,0 +1,67 @@ + + +Credentials Cache API: cc_credentials_f Struct Reference + + + + +

cc_credentials_f Struct Reference

Detailed Description

+Function pointer table for cc_credentials_t. For more information see cc_credentials_t Overview.

Data Fields

+ +

Field Documentation

+ +
+
+ + + + +
cc_int32(* release)(cc_credentials_t io_credentials)
+
+
+ +

+cc_credentials_release(): Release memory associated with a cc_credentials_t object. +

+

Parameters:
+ + +
io_credentials the credentials object to release.
+
+
Returns:
On success, ccNoError. On failure, an error code representing the failure.
+ +
+

+ +

+
+ + + + +
cc_int32(* compare)(cc_credentials_t in_credentials, cc_credentials_t in_compare_to_credentials, cc_uint32 *out_equal)
+
+
+ +

+cc_credentials_compare(): Compare two credentials objects. +

+

Parameters:
+ + + + +
in_credentials a credentials object.
in_compare_to_credentials a credentials object to compare with in_credentials.
out_equal on exit, whether or not the two credentials objects refer to the same credentials in the cache collection.
+
+
Returns:
On success, ccNoError. On failure, an error code representing the failure.
+ +
+

+

Generated on Thu Aug 23 12:45:25 2007 for Credentials Cache API by  + +doxygen 1.5.3
+ + -- cgit