Carbon


ATSUSetTextLayoutRefCon

Header: ATSUnicode.h Carbon status: Supported

Sets application-specific data for a text layout object.

OSStatus ATSUSetTextLayoutRefCon (
    ATSUTextLayout iTextLayout, 
    UInt32 iRefCon
);
Parameter descriptions
iTextLayout

A reference to an initialized text layout object whose application-specific data you want to set. You cannot pass NULL for this parameter.

iRefCon

A 32-bit value, pointer, or handle to application-specific text layout data.

function result

A result code.

DISCUSSION

The ATSUSetTextLayoutRefCon function enables you to associate application-specific data with a text layout object. If you copy or clear a text layout object that contains a reference constant, the reference constant will not be copied or removed. When you dispose of a text layout object that contains a reference constant, you are responsible for freeing any memory allocated for the reference constant. Calling the function ATSUDisposeTextLayout will not do so.

VERSION NOTES

Available 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)