DataBookCursorSetAlphabetIndexFunc

Method type for EDataBookCursorClass.set_alphabetic_index

Sets the cursor state to point to an <link linkend="cursor-alphabet">index into the active alphabet</link>.

The implementing class must check that locale matches the current locale setting of the underlying database and report an e_client_error_out_of_sync error in the case that the locales do not match.

Parameters:

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

Returns:

true on Success, otherwise false is returned if any error occurred and throws is set to reflect the error which occurred.