Carbon


ATSUClearSoftLineBreaks

Header: ATSUnicode.h Carbon status: Supported

Removes soft line breaks from a range of text.

OSStatus ATSUClearSoftLineBreaks (
    ATSUTextLayout iTextLayout, 
    UniCharArrayOffset iRangeStart, 
    UniCharCount iRangeLength
);
Parameter descriptions
iTextLayout

A reference to an initialized text layout object containing the range of text whose soft line break positions you wish to remove. You cannot pass NULL for this parameter.

iRangeStart

The edge offset that corresponds to the beginning of the range of text whose soft line break positions you wish to remove. To specify the beginning of the text buffer, pass the constant kATSUFromTextBeginning, described in “Text Offset and Length Constants”. To indicate the entire text buffer, pass kATSUFromTextBeginning in this parameter and the constant kATSUToTextEnd in the iRangeLength parameter. If the specified range of text is outside the text buffer, ATSUClearSoftLineBreaks returns the result code kATSUInvalidTextRangeErr.

iRangeLength

The length of the range of text whose soft line break positions you want to remove. If you want the length to extend to the end of the text buffer, pass the constant kATSUToTextEnd, described in “Text Offset and Length Constants”. To indicate the entire text buffer, pass kATSUToTextEnd in this parameter and the constant kATSUFromTextBeginning in the iRangeStart parameter. If the specified range of text is outside the text buffer, ATSUClearSoftLineBreaks returns the result code kATSUInvalidTextRangeErr.

function result

A result code.

VERSION NOTES

Available beginning with ATSUI 1.0.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.5 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)