Function

CFStringGetHyphenationLocationBeforeIndex

Retrieve the first potential hyphenation location found before the specified location.

Declaration

CFIndex CFStringGetHyphenationLocationBeforeIndex(CFStringRef string, CFIndex location, CFRange limitRange, CFOptionFlags options, CFLocaleRef locale, UTF32Char *character);

Parameters

string

The string to be hyphenated. If this parameter is not a valid CFString object, the behavior is undefined.

location

An index in the string. If a valid hyphen index is returned, it will be before this index.

limitRange

The range of characters within the string to search. If the range location or end point (defined by the location plus length minus 1) are outside the index space of the string (0 to N-1 inclusive, where N is the length of the string), the behavior is undefined. If the range length is negative, the behavior is undefined. The range may be empty (length 0), in which case no hyphen location is generated.

options

Reserved for future use.

locale

A valid locale that specifies which language's hyphenation conventions to use. Hyphenation data is not available for all locales. You can use CFStringIsHyphenationAvailableForLocale to test for availability of hyphenation data.

character

The suggested hyphen character to insert. Pass NULL if you do not need this information.

Return Value

An index in the string where it is appropriate to insert a hyphen, if one exists; otherwise, kCFNotFound.

See Also

Working With Hyphenation

CFStringIsHyphenationAvailableForLocale

Returns a Boolean value that indicates whether hyphenation data is available.