[Contents] [Index] [Help] [Retrace] [Browse <] [Browse >]

A tag is made up of an attribute/value pair as defined below (from
<utility/tagitem.h>):

    struct TagItem
    {
        ULONG  ti_Tag;    /* identifies the type of this item */
        ULONG  ti_Data;   /* type-specific data, can be a pointer */
    };

The ti_Tag field specifies an attribute to set.  The possible values of
ti_Tag are implementation specific.  System tags are defined in the
include files.  The value the attribute is set to is specified in ti_Data.
An example of the attribute/value pair that will specify a window's name
is:

    ti_Tag  = WA_Title;
    ti_Data = "My Window's Name";

The ti_Data field often contains 32-bit data as well as pointers.

These are brief descriptions of the utility functions you can use to
manipulate and access tags.  For complete descriptions, see the
"Simple Tag Usage" and "Advanced Tag Usage" sections.

The following utility library calls are for supporting tags:


                Table 37-1: Utility Library Tag Functions
  ______________________________________________________________________
 |                                                                      |
 |     AllocateTagItems()  Allocate a TagItem array (or chain).         |
 |         FreeTagItems()  Frees allocated TagItem lists.               |
 |----------------------------------------------------------------------|
 |        CloneTagItems()  Copies a TagItem list.                       |
 | RefreshTagItemClones()  Rejuvenates a clone from the original.       |
 |----------------------------------------------------------------------|
 |          FindTagItem()  Scans TagItem list for a tag.                |
 |           GetTagData()  Obtain data corresponding to tag.            |
 |          NextTagItem()  Iterate TagItem lists.                       |
 |           TagInArray()  Check if a tag value appears in a Tag array. |
 |----------------------------------------------------------------------|
 |     FilterTagChanges()  Eliminate TagItems which specify no change.  |
 |       FilterTagItems()  Remove selected items from a TagItem list.   |
 |              MapTags()  Convert ti_Tag values in a list via map      |
 |                         pairing.                                     |
 |         PackBoolTags()  Builds a "Flag" word from a TagItem list.    |
 |______________________________________________________________________|