Interface DataBookCursorSetAlphabetIndexFunc

Hierarchy

DataBookCursorSetAlphabetIndexFunc

Callable

DataBookCursorSetAlphabetIndexFunc(cursor: DataBookCursor, index: number, locale: string): boolean

- Defined in @types/Gjs/EDataBook-1.2.d.ts:369
Method type for #EDataBookCursorClass.set_alphabetic_index()

Sets the cursor state to point to an
index into the active alphabet.
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: DataBookCursor
  
  an #EDataBookCursor
- index: number
  
  the alphabetic index
- locale: string
  
  the locale in which index is expected to be a valid alphabetic index
Returns boolean