Mac OS 9
Macros | Typedefs | Enumerations | Functions
Collections.h File Reference
Managers

Collection Manager Interfaces. More...

#include <MacTypes.h>
#include <MixedMode.h>

Go to the source code of this file.

Macros

#define NewCollectionFlattenUPP(userRoutine)
 
#define NewCollectionExceptionUPP(userRoutine)
 
#define DisposeCollectionFlattenUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeCollectionExceptionUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeCollectionFlattenUPP(size, data, refCon, userUPP)
 
#define InvokeCollectionExceptionUPP(c, status, userUPP)
 
#define NewCollectionFlattenProc(userRoutine)    NewCollectionFlattenUPP(userRoutine)
 
#define NewCollectionExceptionProc(userRoutine)    NewCollectionExceptionUPP(userRoutine)
 
#define CallCollectionFlattenProc(userRoutine, size, data, refCon)    InvokeCollectionFlattenUPP(size, data, refCon, userRoutine)
 
#define CallCollectionExceptionProc(userRoutine, c, status)    InvokeCollectionExceptionUPP(c, status, userRoutine)
 

Typedefs

typedef struct OpaqueCollection * Collection
 
typedef FourCharCode CollectionTag
 
typedef void * data
 
typedef void void * refCon
 
typedef OSErr status
 

Enumerations

enum  {
  kCollectionDontWantTag = 0L , kCollectionDontWantId = 0L , kCollectionDontWantSize = 0L , kCollectionDontWantAttributes = 0L ,
  kCollectionDontWantIndex = 0L , kCollectionDontWantData = 0L
}
 
enum  { kCollectionNoAttributes = 0x00000000 , kCollectionAllAttributes = (long)0xFFFFFFFF , kCollectionUserAttributes = 0x0000FFFF , kCollectionDefaultAttributes }
 
enum  {
  kCollectionUser0Bit = 0 , kCollectionUser1Bit = 1 , kCollectionUser2Bit = 2 , kCollectionUser3Bit = 3 ,
  kCollectionUser4Bit = 4 , kCollectionUser5Bit = 5 , kCollectionUser6Bit = 6 , kCollectionUser7Bit = 7 ,
  kCollectionUser8Bit = 8 , kCollectionUser9Bit = 9 , kCollectionUser10Bit = 10 , kCollectionUser11Bit = 11 ,
  kCollectionUser12Bit = 12 , kCollectionUser13Bit = 13 , kCollectionUser14Bit = 14 , kCollectionUser15Bit = 15 ,
  kCollectionReserved0Bit = 16 , kCollectionReserved1Bit = 17 , kCollectionReserved2Bit = 18 , kCollectionReserved3Bit = 19 ,
  kCollectionReserved4Bit = 20 , kCollectionReserved5Bit = 21 , kCollectionReserved6Bit = 22 , kCollectionReserved7Bit = 23 ,
  kCollectionReserved8Bit = 24 , kCollectionReserved9Bit = 25 , kCollectionReserved10Bit = 26 , kCollectionReserved11Bit = 27 ,
  kCollectionReserved12Bit = 28 , kCollectionReserved13Bit = 29 , kCollectionPersistenceBit = 30 , kCollectionLockBit = 31
}
 
enum  {
  kCollectionUser0Mask = 1L << kCollectionUser0Bit , kCollectionUser1Mask = 1L << kCollectionUser1Bit , kCollectionUser2Mask = 1L << kCollectionUser2Bit , kCollectionUser3Mask = 1L << kCollectionUser3Bit ,
  kCollectionUser4Mask = 1L << kCollectionUser4Bit , kCollectionUser5Mask = 1L << kCollectionUser5Bit , kCollectionUser6Mask = 1L << kCollectionUser6Bit , kCollectionUser7Mask = 1L << kCollectionUser7Bit ,
  kCollectionUser8Mask = 1L << kCollectionUser8Bit , kCollectionUser9Mask = 1L << kCollectionUser9Bit , kCollectionUser10Mask = 1L << kCollectionUser10Bit , kCollectionUser11Mask = 1L << kCollectionUser11Bit ,
  kCollectionUser12Mask = 1L << kCollectionUser12Bit , kCollectionUser13Mask = 1L << kCollectionUser13Bit , kCollectionUser14Mask = 1L << kCollectionUser14Bit , kCollectionUser15Mask = 1L << kCollectionUser15Bit ,
  kCollectionReserved0Mask = 1L << kCollectionReserved0Bit , kCollectionReserved1Mask = 1L << kCollectionReserved1Bit , kCollectionReserved2Mask = 1L << kCollectionReserved2Bit , kCollectionReserved3Mask = 1L << kCollectionReserved3Bit ,
  kCollectionReserved4Mask = 1L << kCollectionReserved4Bit , kCollectionReserved5Mask = 1L << kCollectionReserved5Bit , kCollectionReserved6Mask = 1L << kCollectionReserved6Bit , kCollectionReserved7Mask = 1L << kCollectionReserved7Bit ,
  kCollectionReserved8Mask = 1L << kCollectionReserved8Bit , kCollectionReserved9Mask = 1L << kCollectionReserved9Bit , kCollectionReserved10Mask = 1L << kCollectionReserved10Bit , kCollectionReserved11Mask = 1L << kCollectionReserved11Bit ,
  kCollectionReserved12Mask = 1L << kCollectionReserved12Bit , kCollectionReserved13Mask = 1L << kCollectionReserved13Bit , kCollectionPersistenceMask = 1L << kCollectionPersistenceBit , kCollectionLockMask = 1L << kCollectionLockBit
}
 
enum  { uppCollectionFlattenProcInfo = 0x00000FE0 }
 
enum  { uppCollectionExceptionProcInfo = 0x000002E0 }
 

Functions

typedef CALLBACK_API (OSErr, CollectionFlattenProcPtr)(SInt32 size
 
typedef CALLBACK_API (OSErr, CollectionExceptionProcPtr)(Collection c
 
typedef STACK_UPP_TYPE (CollectionFlattenProcPtr) CollectionFlattenUPP
 
typedef STACK_UPP_TYPE (CollectionExceptionProcPtr) CollectionExceptionUPP
 
CollectionFlattenUPP NewCollectionFlattenUPP (CollectionFlattenProcPtr userRoutine)
 
CollectionExceptionUPP NewCollectionExceptionUPP (CollectionExceptionProcPtr userRoutine)
 
void DisposeCollectionFlattenUPP (CollectionFlattenUPP userUPP)
 
void DisposeCollectionExceptionUPP (CollectionExceptionUPP userUPP)
 
OSErr InvokeCollectionFlattenUPP (SInt32 size, void *data, void *refCon, CollectionFlattenUPP userUPP)
 
OSErr InvokeCollectionExceptionUPP (Collection c, OSErr status, CollectionExceptionUPP userUPP)
 
Collection NewCollection (void)
 
void DisposeCollection (Collection c)
 
Collection CloneCollection (Collection c)
 
SInt32 CountCollectionOwners (Collection c)
 
OSStatus RetainCollection (Collection c)
 
OSStatus ReleaseCollection (Collection c)
 
ItemCount GetCollectionRetainCount (Collection c)
 
Collection CopyCollection (Collection srcCollection, Collection dstCollection)
 
SInt32 GetCollectionDefaultAttributes (Collection c)
 
void SetCollectionDefaultAttributes (Collection c, SInt32 whichAttributes, SInt32 newAttributes)
 
SInt32 CountCollectionItems (Collection c)
 
OSErr AddCollectionItem (Collection c, CollectionTag tag, SInt32 id, SInt32 itemSize, const void *itemData)
 
OSErr GetCollectionItem (Collection c, CollectionTag tag, SInt32 id, SInt32 *itemSize, void *itemData)
 
OSErr RemoveCollectionItem (Collection c, CollectionTag tag, SInt32 id)
 
OSErr SetCollectionItemInfo (Collection c, CollectionTag tag, SInt32 id, SInt32 whichAttributes, SInt32 newAttributes)
 
OSErr GetCollectionItemInfo (Collection c, CollectionTag tag, SInt32 id, SInt32 *index, SInt32 *itemSize, SInt32 *attributes)
 
OSErr ReplaceIndexedCollectionItem (Collection c, SInt32 index, SInt32 itemSize, const void *itemData)
 
OSErr GetIndexedCollectionItem (Collection c, SInt32 index, SInt32 *itemSize, void *itemData)
 
OSErr RemoveIndexedCollectionItem (Collection c, SInt32 index)
 
OSErr SetIndexedCollectionItemInfo (Collection c, SInt32 index, SInt32 whichAttributes, SInt32 newAttributes)
 
OSErr GetIndexedCollectionItemInfo (Collection c, SInt32 index, CollectionTag *tag, SInt32 *id, SInt32 *itemSize, SInt32 *attributes)
 
Boolean CollectionTagExists (Collection c, CollectionTag tag)
 
SInt32 CountCollectionTags (Collection c)
 
OSErr GetIndexedCollectionTag (Collection c, SInt32 tagIndex, CollectionTag *tag)
 
SInt32 CountTaggedCollectionItems (Collection c, CollectionTag tag)
 
OSErr GetTaggedCollectionItem (Collection c, CollectionTag tag, SInt32 whichItem, SInt32 *itemSize, void *itemData)
 
OSErr GetTaggedCollectionItemInfo (Collection c, CollectionTag tag, SInt32 whichItem, SInt32 *id, SInt32 *index, SInt32 *itemSize, SInt32 *attributes)
 
void PurgeCollection (Collection c, SInt32 whichAttributes, SInt32 matchingAttributes)
 
void PurgeCollectionTag (Collection c, CollectionTag tag)
 
void EmptyCollection (Collection c)
 
OSErr FlattenCollection (Collection c, CollectionFlattenUPP flattenProc, void *refCon)
 
OSErr FlattenPartialCollection (Collection c, CollectionFlattenUPP flattenProc, void *refCon, SInt32 whichAttributes, SInt32 matchingAttributes)
 
OSErr UnflattenCollection (Collection c, CollectionFlattenUPP flattenProc, void *refCon)
 
CollectionExceptionUPP GetCollectionExceptionProc (Collection c)
 
void SetCollectionExceptionProc (Collection c, CollectionExceptionUPP exceptionProc)
 
Collection GetNewCollection (SInt16 collectionID)
 
OSErr AddCollectionItemHdl (Collection aCollection, CollectionTag tag, SInt32 id, Handle itemData)
 
OSErr GetCollectionItemHdl (Collection aCollection, CollectionTag tag, SInt32 id, Handle itemData)
 
OSErr ReplaceIndexedCollectionItemHdl (Collection aCollection, SInt32 index, Handle itemData)
 
OSErr GetIndexedCollectionItemHdl (Collection aCollection, SInt32 index, Handle itemData)
 
OSErr FlattenCollectionToHdl (Collection aCollection, Handle flattened)
 
OSErr UnflattenCollectionFromHdl (Collection aCollection, Handle flattened)
 

Detailed Description

Collection Manager Interfaces.

Introduced In: Carbon
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1989-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ InvokeCollectionExceptionUPP

#define InvokeCollectionExceptionUPP (   c,
  status,
  userUPP 
)
Value:
(OSErr) CALL_TWO_PARAMETER_UPP((userUPP), uppCollectionExceptionProcInfo, \
(c), (status))

◆ InvokeCollectionFlattenUPP

#define InvokeCollectionFlattenUPP (   size,
  data,
  refCon,
  userUPP 
)
Value:
(OSErr) CALL_THREE_PARAMETER_UPP((userUPP), uppCollectionFlattenProcInfo, \
(size), (data), (refCon))

◆ NewCollectionExceptionUPP

#define NewCollectionExceptionUPP (   userRoutine)
Value:
(CollectionExceptionUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppCollectionExceptionProcInfo, \
GetCurrentArchitecture())
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

pascal 2_bytes Func(4_bytes, 2_bytes)

◆ NewCollectionFlattenProc

#define NewCollectionFlattenProc (   userRoutine)     NewCollectionFlattenUPP(userRoutine)

support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewCollectionFlattenUPP

#define NewCollectionFlattenUPP (   userRoutine)
Value:
(CollectionFlattenUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), \
uppCollectionFlattenProcInfo, \
GetCurrentArchitecture())

pascal 2_bytes Func(4_bytes, 4_bytes, 4_bytes)

Typedef Documentation

◆ Collection

typedef struct OpaqueCollection* Collection

Types
abstract data type for a collection

◆ CollectionTag

typedef FourCharCode CollectionTag

collection member 4 byte tag

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Constants Convenience constants for functions which optionally return values

◆ anonymous enum

anonymous enum

attributes bits

Enumerator
kCollectionAllAttributes 

no attributes bits set

kCollectionUserAttributes 

all attributes bits set

kCollectionDefaultAttributes 

user attributes bits

◆ anonymous enum

anonymous enum

Attribute bits 0 through 15 (entire low word) are reserved for use by the application. Attribute bits 16 through 31 (entire high word) are reserved for use by the Collection Manager. Only bits 31 (kCollectionLockBit) and 30 (kCollectionPersistenceBit) currently have meaning.

◆ anonymous enum

anonymous enum

attribute masks

Function Documentation

◆ AddCollectionItem()

OSErr AddCollectionItem ( Collection  c,
CollectionTag  tag,
SInt32  id,
SInt32  itemSize,
const void *  itemData 
)

AddCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ AddCollectionItemHdl()

OSErr AddCollectionItemHdl ( Collection  aCollection,
CollectionTag  tag,
SInt32  id,
Handle  itemData 
)

AddCollectionItemHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CloneCollection()

Collection CloneCollection ( Collection  c)

CloneCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CollectionTagExists()

Boolean CollectionTagExists ( Collection  c,
CollectionTag  tag 
)

CollectionTagExists()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CopyCollection()

Collection CopyCollection ( Collection  srcCollection,
Collection  dstCollection 
)

CopyCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CountCollectionItems()

SInt32 CountCollectionItems ( Collection  c)

CountCollectionItems()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CountCollectionOwners()

SInt32 CountCollectionOwners ( Collection  c)

CountCollectionOwners()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CountCollectionTags()

SInt32 CountCollectionTags ( Collection  c)

CountCollectionTags()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ CountTaggedCollectionItems()

SInt32 CountTaggedCollectionItems ( Collection  c,
CollectionTag  tag 
)

CountTaggedCollectionItems()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeCollection()

void DisposeCollection ( Collection  c)

DisposeCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeCollectionExceptionUPP()

void DisposeCollectionExceptionUPP ( CollectionExceptionUPP  userUPP)

DisposeCollectionExceptionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeCollectionFlattenUPP()

void DisposeCollectionFlattenUPP ( CollectionFlattenUPP  userUPP)

DisposeCollectionFlattenUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ EmptyCollection()

void EmptyCollection ( Collection  c)

EmptyCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ FlattenCollection()

OSErr FlattenCollection ( Collection  c,
CollectionFlattenUPP  flattenProc,
void *  refCon 
)

FlattenCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ FlattenCollectionToHdl()

OSErr FlattenCollectionToHdl ( Collection  aCollection,
Handle  flattened 
)

FlattenCollectionToHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ FlattenPartialCollection()

OSErr FlattenPartialCollection ( Collection  c,
CollectionFlattenUPP  flattenProc,
void *  refCon,
SInt32  whichAttributes,
SInt32  matchingAttributes 
)

FlattenPartialCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionDefaultAttributes()

SInt32 GetCollectionDefaultAttributes ( Collection  c)

GetCollectionDefaultAttributes()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionExceptionProc()

CollectionExceptionUPP GetCollectionExceptionProc ( Collection  c)

GetCollectionExceptionProc()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionItem()

OSErr GetCollectionItem ( Collection  c,
CollectionTag  tag,
SInt32  id,
SInt32 *  itemSize,
void *  itemData 
)

GetCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionItemHdl()

OSErr GetCollectionItemHdl ( Collection  aCollection,
CollectionTag  tag,
SInt32  id,
Handle  itemData 
)

GetCollectionItemHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionItemInfo()

OSErr GetCollectionItemInfo ( Collection  c,
CollectionTag  tag,
SInt32  id,
SInt32 *  index,
SInt32 *  itemSize,
SInt32 *  attributes 
)

GetCollectionItemInfo()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetCollectionRetainCount()

ItemCount GetCollectionRetainCount ( Collection  c)

GetCollectionRetainCount()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ GetIndexedCollectionItem()

OSErr GetIndexedCollectionItem ( Collection  c,
SInt32  index,
SInt32 *  itemSize,
void *  itemData 
)

GetIndexedCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetIndexedCollectionItemHdl()

OSErr GetIndexedCollectionItemHdl ( Collection  aCollection,
SInt32  index,
Handle  itemData 
)

GetIndexedCollectionItemHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetIndexedCollectionItemInfo()

OSErr GetIndexedCollectionItemInfo ( Collection  c,
SInt32  index,
CollectionTag *  tag,
SInt32 *  id,
SInt32 *  itemSize,
SInt32 *  attributes 
)

GetIndexedCollectionItemInfo()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetIndexedCollectionTag()

OSErr GetIndexedCollectionTag ( Collection  c,
SInt32  tagIndex,
CollectionTag *  tag 
)

GetIndexedCollectionTag()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetNewCollection()

Collection GetNewCollection ( SInt16  collectionID)

GetNewCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetTaggedCollectionItem()

OSErr GetTaggedCollectionItem ( Collection  c,
CollectionTag  tag,
SInt32  whichItem,
SInt32 *  itemSize,
void *  itemData 
)

GetTaggedCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetTaggedCollectionItemInfo()

OSErr GetTaggedCollectionItemInfo ( Collection  c,
CollectionTag  tag,
SInt32  whichItem,
SInt32 *  id,
SInt32 *  index,
SInt32 *  itemSize,
SInt32 *  attributes 
)

GetTaggedCollectionItemInfo()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ InvokeCollectionExceptionUPP()

OSErr InvokeCollectionExceptionUPP ( Collection  c,
OSErr  status,
CollectionExceptionUPP  userUPP 
)

InvokeCollectionExceptionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ InvokeCollectionFlattenUPP()

OSErr InvokeCollectionFlattenUPP ( SInt32  size,
void *  data,
void *  refCon,
CollectionFlattenUPP  userUPP 
)

InvokeCollectionFlattenUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewCollection()

Collection NewCollection ( void  )

CALL_NOT_IN_CARBON NewCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewCollectionExceptionUPP()

CollectionExceptionUPP NewCollectionExceptionUPP ( CollectionExceptionProcPtr  userRoutine)

NewCollectionExceptionUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewCollectionFlattenUPP()

CollectionFlattenUPP NewCollectionFlattenUPP ( CollectionFlattenProcPtr  userRoutine)

NewCollectionFlattenUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ PurgeCollection()

void PurgeCollection ( Collection  c,
SInt32  whichAttributes,
SInt32  matchingAttributes 
)

PurgeCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ PurgeCollectionTag()

void PurgeCollectionTag ( Collection  c,
CollectionTag  tag 
)

PurgeCollectionTag()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ ReleaseCollection()

OSStatus ReleaseCollection ( Collection  c)

ReleaseCollection()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ RemoveCollectionItem()

OSErr RemoveCollectionItem ( Collection  c,
CollectionTag  tag,
SInt32  id 
)

RemoveCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ RemoveIndexedCollectionItem()

OSErr RemoveIndexedCollectionItem ( Collection  c,
SInt32  index 
)

RemoveIndexedCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ ReplaceIndexedCollectionItem()

OSErr ReplaceIndexedCollectionItem ( Collection  c,
SInt32  index,
SInt32  itemSize,
const void *  itemData 
)

ReplaceIndexedCollectionItem()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ ReplaceIndexedCollectionItemHdl()

OSErr ReplaceIndexedCollectionItemHdl ( Collection  aCollection,
SInt32  index,
Handle  itemData 
)

ReplaceIndexedCollectionItemHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ RetainCollection()

OSStatus RetainCollection ( Collection  c)

RetainCollection()

Non-Carbon CFM: not available
Carbon Lib: in CarbonLib 1.1 and later
Mac OS X: in version 10.0 and later

◆ SetCollectionDefaultAttributes()

void SetCollectionDefaultAttributes ( Collection  c,
SInt32  whichAttributes,
SInt32  newAttributes 
)

SetCollectionDefaultAttributes()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ SetCollectionExceptionProc()

void SetCollectionExceptionProc ( Collection  c,
CollectionExceptionUPP  exceptionProc 
)

SetCollectionExceptionProc()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ SetCollectionItemInfo()

OSErr SetCollectionItemInfo ( Collection  c,
CollectionTag  tag,
SInt32  id,
SInt32  whichAttributes,
SInt32  newAttributes 
)

SetCollectionItemInfo()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ SetIndexedCollectionItemInfo()

OSErr SetIndexedCollectionItemInfo ( Collection  c,
SInt32  index,
SInt32  whichAttributes,
SInt32  newAttributes 
)

SetIndexedCollectionItemInfo()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ UnflattenCollection()

OSErr UnflattenCollection ( Collection  c,
CollectionFlattenUPP  flattenProc,
void *  refCon 
)

UnflattenCollection()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ UnflattenCollectionFromHdl()

OSErr UnflattenCollectionFromHdl ( Collection  aCollection,
Handle  flattened 
)

UnflattenCollectionFromHdl()

Non-Carbon CFM: in CollectionsLib 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later