Retrieve the first potential hyphenation location found before the specified location.
- iOS 4.2+
- macOS 10.7+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
- Core Foundation
The string to be hyphenated. If this parameter is not a valid CFString object, the behavior is undefined.
An index in the string. If a valid hyphen index is returned, it will be before this index.
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.
Reserved for future use.
A valid locale that specifies which language's hyphenation conventions to use. Hyphenation data is not available for all locales. You can use
CFStringto test for availability of hyphenation data.
Is Hyphenation Available For Locale
The suggested hyphen character to insert. Pass
NULLif you do not need this information.
An index in the string where it is appropriate to insert a hyphen, if one exists; otherwise,