Virtual Method

EDataBookDataBookCursorset_alphabetic_index

Declaration [src]

gboolean
set_alphabetic_index (
  EDataBookCursor* cursor,
  gint index,
  const gchar* locale,
  GError** error
)

Description [src]

The EDataBookCursorSetAlphabetIndexFunc delegate to set the alphabetic position.

Parameters

index

Type: gint

The alphabetic index.

locale

Type: const gchar*

The locale in which index is expected to be a valid alphabetic index.

The data is owned by the caller of the method.
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 be 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 is returned if any error occurred and error is set to reflect the error which occurred.