Virtual Method

AgsAuthenticationlogin

since: 3.0.0

Declaration [src]

gboolean
login (
  AgsAuthentication* authentication,
  gchar* login,
  gchar* password,
  gchar** user_uuid,
  gchar** security_token,
  GError** error
)

Description [src]

Login.

Available since: 3.0.0

Parameters

login

Type: gchar*

The login.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
password

Type: gchar*

The password.

The data is owned by the caller of the function.
The value is a NUL terminated UTF-8 string.
user_uuid

Type: gchar**

Return location of the user’s uuid.

The argument will be set by the function.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
security_token

Type: gchar**

Return location of the security token.

The argument will be set by the function.
The called function takes ownership of the data, and is responsible for freeing it.
The value is a NUL terminated UTF-8 string.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will left initialized to NULL by the virtual function if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: gboolean

TRUE on success, otherwise FALSE.