summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Dauvergne <bdauvergne@entrouvert.com>2009-04-27 08:18:57 +0000
committerBenjamin Dauvergne <bdauvergne@entrouvert.com>2009-04-27 08:18:57 +0000
commit913f1596971fd73fda038e37ce75ec31965557be (patch)
tree51ed53ab6f09512fed084e6f5271575af329865d
parent52e60ecb097216e2deb0eda898d38425ed665a07 (diff)
Complete doc of lasso_logout_validate_request
* lasso/id-ff/logout.c: add description of all possible return codes.
-rw-r--r--lasso/id-ff/logout.c16
1 files changed, 15 insertions, 1 deletions
diff --git a/lasso/id-ff/logout.c b/lasso/id-ff/logout.c
index bed9dc78..ebc21d7b 100644
--- a/lasso/id-ff/logout.c
+++ b/lasso/id-ff/logout.c
@@ -820,7 +820,21 @@ gint lasso_logout_reset_providerID_index(LassoLogout *logout)
* </para></listitem>
* </itemizedlist>
*
- * Return value: 0 on success; or a negative value otherwise.
+ * Return value: 0 on success; or
+ * LASSO_PROFILE_ERROR_MISSING_REQUEST if no request has been found -- usually means that
+ * lasso_logout_process_request_msg was not called,
+ * LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the requesting provider is not known to the server object,
+ * LASSO_PROFILE_ERROR_BUILDING_RESPONSE_FAILED if creation of the response object failed,
+ * LASSO_PROFILE_ERROR_NAME_IDENTIFIER_NOT_FOUND if the request do not contain a NameID element,
+ * LASSO_PROFILE_ERROR_SESSION_NOT_FOUND if the logout profile object do not contain a session
+ * object,
+ * LASSO_PROFILE_ERROR_MISSING_ASSERTION if no assertion from the requesting provider was found,
+ * LASSO_PROFILE_ERROR_IDENTITY_NOT_FOUND if the logout profile object do not contain an identity
+ * object,
+ * LASSO_PROFILE_ERROR_FEDERATION_NOT_FOUND if no federation for the requesting provider was found,
+ * LASSO_LOGOUT_ERROR_UNSUPPORTED_PROFILE if the requested HTTP method is not supported by all the
+ * remote provider of the current session.
+ *
**/
gint
lasso_logout_validate_request(LassoLogout *logout)