set_alphabetic_index


Description:

public bool set_alphabetic_index (int index, string locale, Cancellable? cancellable = null) throws Error

Sets the this position to an <link linkend="cursor-alphabet">Alphabetic Index</link> into the alphabet active in the locale of the addressbook.

After setting the target to an alphabetic index, for example the index for letter 'E', then further calls to step will return results starting with the letter 'E' (or results starting with the last result in 'D', if moving in a negative direction).

The passed index must be a valid index in locale, if by some chance the addressbook backend has changed into a new locale after this call has been issued, an e_client_error_out_of_sync error will be issued indicating that there was a locale mismatch.

Parameters:

this

an DataBookCursor

index

the alphabetic index

locale

the locale in which index is expected to be a valid alphabetic index

cancellable

A Cancellable

Returns:

true on success, otherwise false is returned and throws is set.