Virtual Method

PurpleProtocolcreate_connection

since: 3.0

Declaration [src]

PurpleConnection*
create_connection (
  PurpleProtocol* protocol,
  PurpleAccount* account,
  const char* password,
  GError** error
)

Description [src]

Creates a PurpleConnection for account.

A protocol may indicate an error by setting error and returning NULL.

Available since: 3.0

Parameters

account

Type: PurpleAccount

The PurpleAccount for the connection.

The data is owned by the caller of the function.
password

Type: const char*

The password for the account.

The data is owned by the caller of the function.
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: PurpleConnection

The new connection or NULL with error possibly set on error.

The caller of the function takes ownership of the data, and is responsible for freeing it.