diff options
| author | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:18 +0000 |
|---|---|---|
| committer | Benjamin Dauvergne <bdauvergne@entrouvert.com> | 2009-04-27 08:19:18 +0000 |
| commit | c7ec6c1ed9fccd50ffa206d3dfa9a36fc9c9acf4 (patch) | |
| tree | 92a1581836d13e09cd25c3b0f5314e856958bb87 | |
| parent | 22e51935c71fddc9aa54cad39007a8db27286a61 (diff) | |
lasso_login_init_authn_request: complete doc
* lasso/id-ff/login.c:
add all possible return codes and their meaning.
| -rw-r--r-- | lasso/id-ff/login.c | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/lasso/id-ff/login.c b/lasso/id-ff/login.c index 2f55da4a..dbc065a2 100644 --- a/lasso/id-ff/login.c +++ b/lasso/id-ff/login.c @@ -1342,7 +1342,16 @@ lasso_login_destroy(LassoLogin *login) * identity provider specified in @remote_providerID (if NULL the first known * identity provider is used). * - * Return value: 0 on success; or a negative value otherwise. + * Return value: 0 on success; or + * LASSO_PARAM_ERROR_BAD_TYPE_OR_NULL_OBJ if login is not a #LassoLogin object, + * LASSO_PROFILE_ERROR_MISSING_REMOTE_PROVIDERID if @remote_providerID is NULL and no default remote + * provider could be found from the server object -- usually the first one in the order of adding to + * the server object --, + * LASSO_SERVER_ERROR_PROVIDER_NOT_FOUND if the @remote_providerID is not known to our server object. + * LASSO_PROFILE_ERROR_INVALID_HTTP_METHOD if the HTTP method is neither LASSO_HTTP_METHOD_REDIRECT + * or LASSO_HTTP_METHOD_POST, + * LASSO_PROFILE_ERROR_BUILDING_REQUEST_FAILED if creation of the request object failed. + * **/ gint lasso_login_init_authn_request(LassoLogin *login, const gchar *remote_providerID, |