Carbon


ATSUGetAllAttributes

Header: ATSUnicode.h Carbon status: Supported

Obtains attribute information from a style object.

OSStatus ATSUGetAllAttributes (
    ATSUStyle iStyle, 
    ATSUAttributeInfo oAttributeInfoArray[], 
    ItemCount iTagValuePairArraySize, 
    ItemCount *oTagValuePairCount
);
Parameter descriptions
iStyle

A reference to a valid style object whose style run attribute information you want to obtain. You cannot pass NULL for this parameter.

oAttributeInfoArray

An array of attribute tag/value size pairs. Before calling ATSUGetAllAttributes, pass a pointer to memory that you have allocated for this array. If you are uncertain of how much memory to allocate, see the discussion below. On return, an array of the tag and value size pairs corresponding to all previously set style run attribute values in the style object.

iTagValuePairArraySize

The maximum number of tag and value size pairs in the style object. Typically, this is equivalent to the number of ATSUAttributeInfo structures in the oAttributeInfoArray array. To determine this value, see the discussion below.

oTagValuePairCount

On return, a pointer to the actual number of ATSUAttributeInfo structures in the style object. This may be greater than the value you specified in the iTagValuePairArraySize parameter. You cannot pass NULL for this parameter.

function result

A result code.

DISCUSSION

The ATSUGetAllAttributes function determines all previously set style run attributes contained in a style object. You can pass a tag and value size pair that ATSUGetAllAttributes passes back as an element of the oAttributeInfoArray array to the function ATSUGetAttribute to determine the corresponding attribute value. The best way to use ATSUGetAllAttributes is to call it twice:

  1. Pass a reference to the style object containing the attribute in the iStyle parameter, NULL for the oAttributeInfoArray parameter, and 0 for the other parameters. ATSUGetAllAttributes returns the size of the tag and value size arrays in the oTagValuePairCount parameter.
  2. Allocate enough space for an array of the returned size, then call the function again, passing a pointer in the oAttributeInfoArray parameter. On return, the pointer points to an array of the style run attribute tag and value size pairs contained in the style object.

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)