Movatterモバイル変換

DONE is returned by previous() and next() after all valid matches have been returned, and by first() and last() if there are no matches at all.

Stable:

ICU 2.4

Definition at line151 of fileusearch.h.

Data structure for searching.

Stable:

ICU 2.4

Definition at line1 of fileusearch.h.

Stable:

ICU 2.4

Definition at line167 of fileusearch.h.

Stable:

ICU 2.4

Definition at line209 of fileusearch.h.

Destroys and cleans up the String Search iterator data struct.

If a collator was created inusearch_open, then it will be destroyed here.

Parameters

searchiter

The UStringSearch to clean up

Stable:

ICU 2.4

Returns the first index at which the string text matches the search pattern.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE.

Parameters

strsrch	search iterator data struct
status	for errors if it occurs

Returns

The character index of the first match, orUSEARCH_DONE if there are no matches.

See also

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Returns the first index equal or greater thanposition at which the string text matches the search pattern.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE

Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned

Parameters

strsrch	search iterator data struct
position	to start the search at
status	for errors if it occurs

Returns

The character index of the first match followingpos, orUSEARCH_DONE if there are no matches.

See also

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Gets the text searching attributes.

Parameters

strsrch	search iterator data struct
attribute	text attribute to be retrieve

Returns

text attribute value

See also

usearch_setAttribute

Stable:

ICU 2.4

Returns the BreakIterator that is used to restrict the points at which matches are detected.

This will be the same object that was passed to the constructor or tousearch_setBreakIterator. Note thatNULL is a legal value; it means that break detection should not be attempted.

Parameters

strsrch

search iterator data struct

Returns

break iterator used

See also

usearch_setBreakIterator

Stable:

ICU 2.4

Gets the collator used for the language rules.

Deleting the returnedUCollator before callingusearch_close would cause the string search to fail.usearch_close will delete the collator if this search owns it.

Parameters

strsrch

search iterator data struct

Returns

collator

Stable:

ICU 2.4

Returns the length of text in the string which matches the search pattern.

This call returns a valid result only after a successful call tousearch_first,usearch_next,usearch_previous, orusearch_last. Just after construction, or after a searching method returnsUSEARCH_DONE, this method will return 0.

Parameters

strsrch

search iterator data struct

Returns

The length of the match in the string text, or 0 if there is no match currently.

See also

usearch_first

usearch_next

usearch_previous

usearch_last

USEARCH_DONE

Stable:

ICU 2.4

Returns the index to the match in the text string that was searched.

This call returns a valid result only after a successful call tousearch_first,usearch_next,usearch_previous, orusearch_last. Just after construction, or after a searching method returnsUSEARCH_DONE, this method will returnUSEARCH_DONE.

Useusearch_getMatchedLength to get the matched string length.

Parameters

strsrch

search iterator data struct

Returns

index to a substring within the text string that is being searched.

See also

usearch_first

usearch_next

usearch_previous

usearch_last

USEARCH_DONE

Stable:

ICU 2.4

Returns the text that was matched by the most recent call tousearch_first,usearch_next,usearch_previous, orusearch_last.

If the iterator is not pointing at a valid match (e.g. just after construction or afterUSEARCH_DONE has been returned, returns an empty string. If result is not large enough to store the matched text, result will be filled with the partial text and an U_BUFFER_OVERFLOW_ERROR will be returned in status. result will be null-terminated whenever possible. If the buffer fits the matched text exactly, a null-termination is not possible, then a U_STRING_NOT_TERMINATED_ERROR set in status. Pre-flighting can be either done with length = 0 or the APIusearch_getMatchedLength.

Parameters

strsrch	search iterator data struct
result	UChar buffer to store the matched string
resultCapacity	length of the result buffer
status	error returned if result is not large enough

Returns

exact length of the matched text, not counting the null-termination

See also

usearch_first

usearch_next

usearch_previous

usearch_last

USEARCH_DONE

Stable:

ICU 2.4

Return the current index in the string text being searched.

If the iteration has gone past the end of the text (or past the beginning for a backwards search),USEARCH_DONE is returned.

Parameters

strsrch

search iterator data struct

See also

USEARCH_DONE

Stable:

ICU 2.4

Gets the search pattern.

Parameters

strsrch	search iterator data struct
length	return length of the pattern, -1 indicates that the pattern is null-terminated

Returns

pattern string

Stable:

ICU 2.4

Return the string text to be searched.

Parameters

strsrch	search iterator data struct
length	returned string text length

Returns

string text

See also

usearch_setText

Stable:

ICU 2.4

Returns the last index in the target text at which it matches the search pattern.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE.

Parameters

strsrch	search iterator data struct
status	for errors if it occurs

Returns

The index of the first match, orUSEARCH_DONE if there are no matches.

See also

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Returns the index of the next point at which the string text matches the search pattern, starting from the current position.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE

Parameters

strsrch	search iterator data struct
status	for errors if it occurs

Returns

The index of the next match after the current position, orUSEARCH_DONE if there are no more matches.

See also

usearch_first

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Creates a String Search iterator data struct using the argument locale language rule set.

A collator will be created in the process, which will be owned by this String Search and will be deleted inusearch_close.

The UStringSearch retains a pointer to both the pattern and text strings. The caller must not modify or delete them while using the UStringSearch.

Parameters

pattern	for matching
patternlength	length of the pattern, -1 for null-termination
text	text string
textlength	length of the text string, -1 for null-termination
locale	name of locale for the rules to be used
breakiter	A BreakIterator that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by theBreakIterator, the match will be rejected and another will be searched for. If this parameter isNULL, no break detection is attempted.
status	for errors if it occurs. If pattern or text is NULL, or if patternlength or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.

Returns

search iterator data structure, or NULL if there is an error.

Stable:

ICU 2.4

Creates a String Search iterator data struct using the argument collator language rule set.

Note, user retains the ownership of this collator, thus the responsibility of deletion lies with the user.

NOTE: String Search cannot be instantiated from a collator that has collate digits as numbers (CODAN) turned on (UCOL_NUMERIC_COLLATION).

The UStringSearch retains a pointer to both the pattern and text strings. The caller must not modify or delete them while using the UStringSearch.

Parameters

pattern	for matching
patternlength	length of the pattern, -1 for null-termination
text	text string
textlength	length of the text string, -1 for null-termination
collator	used for the language rules
breakiter	A BreakIterator that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by theBreakIterator, the match will be rejected and another will be searched for. If this parameter isNULL, no break detection is attempted.
status	for errors if it occurs. If collator, pattern or text is NULL, or if patternlength or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned.

Returns

search iterator data structure, or NULL if there is an error.

Stable:

ICU 2.4

Returns the first index less thanposition at which the string text matches the search pattern.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE

Search positions that may render incorrect results are highlighted in the header comments. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned.

WhenUSEARCH_OVERLAP option is off, the last index of the result match is always less thanposition. WhenUSERARCH_OVERLAP is on, the result match may span acrossposition.

Parameters

strsrch	search iterator data struct
position	index position the search is to begin at
status	for errors if it occurs

Returns

The character index of the first match precedingpos, orUSEARCH_DONE if there are no matches.

See also

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Returns the index of the previous point at which the string text matches the search pattern, starting at the current position.

The iterator is adjusted so that its current index (as returned byusearch_getOffset) is the match position if one was found. If a match is not found,USEARCH_DONE will be returned and the iterator will be adjusted to the indexUSEARCH_DONE

Parameters

strsrch	search iterator data struct
status	for errors if it occurs

Returns

The index of the previous match before the current position, orUSEARCH_DONE if there are no more matches.

See also

usearch_last

usearch_getOffset

USEARCH_DONE

Stable:

ICU 2.4

Reset the iteration.

Search will begin at the start of the text string if a forward iteration is initiated before a backwards iteration. Otherwise if a backwards iteration is initiated before a forwards iteration, the search will begin at the end of the text string.

Parameters

strsrch

search iterator data struct

See also

usearch_first

Stable:

ICU 2.4

Simple forward search for the pattern, starting at a specified index, and using a default set search options.

This is an experimental function, and is not an official part of the ICU API.

The collator options, such as UCOL_STRENGTH and UCOL_NORMALIZTION, are honored.

The UStringSearch options USEARCH_CANONICAL_MATCH, USEARCH_OVERLAP and any Break Iterator are ignored.

Matches obey the following constraints:

Characters at the start or end positions of a match that are ignorablefor collation are not included as part of the match, unless theyare part of a combining sequence, as described below.A match will not include a partial combining sequence.  Combiningcharacter sequences  are considered to be  inseparable units,and either match the pattern completely, or are considered to not matchat all.  Thus, for example, an A followed a combining accent mark will not be found when searching for a plain (unaccented) A.   (unlessthe collation strength has been set to ignore all accents).When beginning a search, the initial starting position, startIdx,is assumed to be an acceptable match boundary with respect tocombining characters.  A combining sequence that spans across thestarting point will not suppress a match beginning at startIdx.Characters that expand to multiple collation elements(German sharp-S becoming 'ss', or the composed forms of accentedcharacters, for example) also must match completely.Searching for a single 's' in a string containing only a sharp-s will find no match.

Parameters

strsrch	the UStringSearch struct, which references both the text to be searched and the pattern being sought.
startIdx	The index into the text to begin the search.
matchStart	An out parameter, the starting index of the matched text. This parameter may be NULL. A value of -1 will be returned if no match was found.
matchLimit	Out parameter, the index of the first position following the matched text. The matchLimit will be at a suitable position for beginning a subsequent search in the input text. This parameter may be NULL. A value of -1 will be returned if no match was found.
status	Report any errors. Note that no match found is not an error.

Returns

true if a match was found, false otherwise.

Internal:

Do not use. This API is for internal use only.

Simple backwards search for the pattern, starting at a specified index, and using using a default set search options.

This is an experimental function, and is not an official part of the ICU API.

The collator options, such as UCOL_STRENGTH and UCOL_NORMALIZTION, are honored.

The UStringSearch options USEARCH_CANONICAL_MATCH, USEARCH_OVERLAP and any Break Iterator are ignored.

Matches obey the following constraints:

Characters at the start or end positions of a match that are ignorablefor collation are not included as part of the match, unless theyare part of a combining sequence, as described below.A match will not include a partial combining sequence.  Combiningcharacter sequences  are considered to be  inseparable units,and either match the pattern completely, or are considered to not matchat all.  Thus, for example, an A followed a combining accent mark will not be found when searching for a plain (unaccented) A.   (unlessthe collation strength has been set to ignore all accents).When beginning a search, the initial starting position, startIdx,is assumed to be an acceptable match boundary with respect tocombining characters.  A combining sequence that spans across thestarting point will not suppress a match beginning at startIdx.Characters that expand to multiple collation elements(German sharp-S becoming 'ss', or the composed forms of accentedcharacters, for example) also must match completely.Searching for a single 's' in a string containing only a sharp-s will find no match.

Parameters

strsrch	the UStringSearch struct, which references both the text to be searched and the pattern being sought.
startIdx	The index into the text to begin the search.
matchStart	An out parameter, the starting index of the matched text. This parameter may be NULL. A value of -1 will be returned if no match was found.
matchLimit	Out parameter, the index of the first position following the matched text. The matchLimit will be at a suitable position for beginning a subsequent search in the input text. This parameter may be NULL. A value of -1 will be returned if no match was found.
status	Report any errors. Note that no match found is not an error.

Returns

true if a match was found, false otherwise.

Internal:

Do not use. This API is for internal use only.

Sets the text searching attributes located in the enum USearchAttribute with values from the enum USearchAttributeValue.

USEARCH_DEFAULT can be used for all attributes for resetting.

Parameters

strsrch	search iterator data struct
attribute	text attribute to be set
value	text attribute value
status	for errors if it occurs

See also

usearch_getAttribute

Stable:

ICU 2.4

Set the BreakIterator that will be used to restrict the points at which matches are detected.

Parameters

strsrch	search iterator data struct
breakiter	A BreakIterator that will be used to restrict the points at which matches are detected. If a match is found, but the match's start or end index is not a boundary as determined by theBreakIterator, the match will be rejected and another will be searched for. If this parameter isNULL, no break detection is attempted.
status	for errors if it occurs

See also

usearch_getBreakIterator

Stable:

ICU 2.4

Sets the collator used for the language rules.

User retains the ownership of this collator, thus the responsibility of deletion lies with the user. This method causes internal data such as the pattern collation elements and shift tables to be recalculated, but the iterator's position is unchanged.

Parameters

strsrch	search iterator data struct
collator	to be used
status	for errors if it occurs

Stable:

ICU 2.4

Sets the current position in the text string which the next search will start from.

Clears previous states. This method takes the argument index and sets the position in the text string accordingly without checking if the index is pointing to a valid starting point to begin searching. Search positions that may render incorrect results are highlighted in the header comments

Parameters

strsrch	search iterator data struct
position	position to start next search from. If position is less than or greater than the text range for searching, an U_INDEX_OUTOFBOUNDS_ERROR will be returned
status	error status if any.

Stable:

ICU 2.4

Sets the pattern used for matching.

Internal data like the pattern collation elements will be recalculated, but the iterator's position is unchanged.

The UStringSearch retains a pointer to the pattern string. The caller must not modify or delete the string while using the UStringSearch.

Parameters

strsrch	search iterator data struct
pattern	string
patternlength	pattern length, -1 for null-terminated string
status	for errors if it occurs. If text is NULL, or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change done to strsrch.

Stable:

ICU 2.4

Set the string text to be searched.

Text iteration will hence begin at the start of the text string. This method is useful if you want to re-use an iterator to search for the same pattern within a different body of text.

The UStringSearch retains a pointer to the text string. The caller must not modify or delete the string while using the UStringSearch.

Parameters

strsrch	search iterator data struct
text	new string to look for match
textlength	length of the new string, -1 for null-termination
status	for errors if it occurs. If text is NULL, or textlength is 0 then an U_ILLEGAL_ARGUMENT_ERROR is returned with no change done to strsrch.

See also

usearch_getText

Stable:

ICU 2.4