Method

EBookBookClientget_contact_sync

since: 3.2

Declaration [src]

gboolean
e_book_client_get_contact_sync (
  EBookClient* client,
  const gchar* uid,
  EContact** out_contact,
  GCancellable* cancellable,
  GError** error
)

Description [src]

Receive EContact from the client for the gived uid. If successful, then the out_contact is set to newly allocated EContact, which should be freed with g_object_unref().

Available since: 3.2

Parameters

uid

Type: const gchar*

A unique string ID specifying the contact.

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

Type: EContact

An EContact for given uid.

The argument will be set by the function.
The caller of the method takes ownership of the returned data, and is responsible for freeing it.
cancellable

Type: GCancellable

A GCancellable; can be NULL.

The argument can be NULL.
The data is owned by the caller of the method.
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 be left initialized to NULL by the method 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 if successful, FALSE otherwise.