Logo Search packages:      
Sourcecode: icu version File versions  Download package

typedef UBool U_CALLCONV UTextAccess(UText *ut, int64_t nativeIndex, UBool forward)

Function type declaration for UText.access(). Get the description of the text chunk containing the text at a requested native index. The UText's iteration position will be left at the requested index. If the index is out of bounds, the iteration position will be left at the start or end of the string, as appropriate.

Chunks must begin and end on code point boundaries. A single code point comprised of multiple storage units must never span a chunk boundary.

Parameters:
ut the UText being accessed.
nativeIndex Requested index of the text to be accessed.
forward If TRUE, then the returned chunk must contain text starting from the index, so that start<=index<limit. If FALSE, then the returned chunk must contain text before the index, so that start<index<=limit.
Returns:
True if the requested index could be accessed. The chunk will contain the requested text. False value if a chunk cannot be accessed (the requested index is out of bounds).
See also:
UText ICU 3.4

Definition at line 1178 of file utext.h.


Generated by  Doxygen 1.6.0   Back to index