Mac OS 9
AEObjects.h File Reference

Object Support Library Interfaces. More...

#include <OSUtils.h>
#include <AppleEvents.h>

Go to the source code of this file.

Data Structures

struct  ccntTokenRecord
 

Typedefs

typedef struct ccntTokenRecord ccntTokenRecord
 
typedef ccntTokenRecordccntTokenRecPtr
 
typedef ccntTokenRecPtrccntTokenRecHandle
 
typedef AEDescDescPtr
 
typedef DescPtrDescHandle
 
typedef const AEDesccontainer
 
typedef const AEDesc DescType containerClass
 
typedef const AEDesc DescType DescType form
 
typedef const AEDesc DescType DescType const AEDescselectionData
 
typedef const AEDesc DescType DescType const AEDesc AEDescvalue
 
typedef const AEDesc DescType DescType const AEDesc AEDesc long accessorRefcon
 
typedef const AEDescobj1
 
typedef const AEDesc const AEDescobj2
 
typedef const AEDesc const AEDesc Booleanresult
 
typedef const AEDescmarkToken
 
typedef const AEDesc long index
 
typedef long newStop
 

Enumerations

enum  {
  kAEAND = FOUR_CHAR_CODE('AND ') , kAEOR = FOUR_CHAR_CODE('OR ') , kAENOT = FOUR_CHAR_CODE('NOT ') , kAEFirst = FOUR_CHAR_CODE('firs') ,
  kAELast = FOUR_CHAR_CODE('last') , kAEMiddle = FOUR_CHAR_CODE('midd') , kAEAny = FOUR_CHAR_CODE('any ') , kAEAll = FOUR_CHAR_CODE('all ') ,
  kAENext = FOUR_CHAR_CODE('next') , kAEPrevious = FOUR_CHAR_CODE('prev') , keyAECompOperator = FOUR_CHAR_CODE('relo') , keyAELogicalTerms = FOUR_CHAR_CODE('term') ,
  keyAELogicalOperator = FOUR_CHAR_CODE('logc') , keyAEObject1 = FOUR_CHAR_CODE('obj1') , keyAEObject2 = FOUR_CHAR_CODE('obj2') , keyAEDesiredClass = FOUR_CHAR_CODE('want') ,
  keyAEContainer = FOUR_CHAR_CODE('from') , keyAEKeyForm = FOUR_CHAR_CODE('form') , keyAEKeyData = FOUR_CHAR_CODE('seld')
}
 
enum  {
  keyAERangeStart = FOUR_CHAR_CODE('star') , keyAERangeStop = FOUR_CHAR_CODE('stop') , keyDisposeTokenProc = FOUR_CHAR_CODE('xtok') , keyAECompareProc = FOUR_CHAR_CODE('cmpr') ,
  keyAECountProc = FOUR_CHAR_CODE('cont') , keyAEMarkTokenProc = FOUR_CHAR_CODE('mkid') , keyAEMarkProc = FOUR_CHAR_CODE('mark') , keyAEAdjustMarksProc = FOUR_CHAR_CODE('adjm') ,
  keyAEGetErrDescProc = FOUR_CHAR_CODE('indc')
}
 
enum  {
  formAbsolutePosition = FOUR_CHAR_CODE('indx') , formRelativePosition = FOUR_CHAR_CODE('rele') , formTest = FOUR_CHAR_CODE('test') , formRange = FOUR_CHAR_CODE('rang') ,
  formPropertyID = FOUR_CHAR_CODE('prop') , formName = FOUR_CHAR_CODE('name') , typeObjectSpecifier = FOUR_CHAR_CODE('obj ') , typeObjectBeingExamined = FOUR_CHAR_CODE('exmn') ,
  typeCurrentContainer = FOUR_CHAR_CODE('ccnt') , typeToken = FOUR_CHAR_CODE('toke') , typeRelativeDescriptor = FOUR_CHAR_CODE('rel ') , typeAbsoluteOrdinal = FOUR_CHAR_CODE('abso') ,
  typeIndexDescriptor = FOUR_CHAR_CODE('inde') , typeRangeDescriptor = FOUR_CHAR_CODE('rang') , typeLogicalDescriptor = FOUR_CHAR_CODE('logi') , typeCompDescriptor = FOUR_CHAR_CODE('cmpd') ,
  typeOSLTokenList = FOUR_CHAR_CODE('ostl')
}
 
enum  {
  kAEIDoMinimum = 0x0000 , kAEIDoWhose = 0x0001 , kAEIDoMarking = 0x0004 , kAEPassSubDescs = 0x0008 ,
  kAEResolveNestedLists = 0x0010 , kAEHandleSimpleRanges = 0x0020 , kAEUseRelativeIterators = 0x0040
}
 
enum  {
  typeWhoseDescriptor = FOUR_CHAR_CODE('whos') , formWhose = FOUR_CHAR_CODE('whos') , typeWhoseRange = FOUR_CHAR_CODE('wrng') , keyAEWhoseRangeStart = FOUR_CHAR_CODE('wstr') ,
  keyAEWhoseRangeStop = FOUR_CHAR_CODE('wstp') , keyAEIndex = FOUR_CHAR_CODE('kidx') , keyAETest = FOUR_CHAR_CODE('ktst')
}
 
enum  { uppOSLAccessorProcInfo = 0x000FFFE0 }
 
enum  { uppOSLCompareProcInfo = 0x00003FE0 }
 
enum  { uppOSLCountProcInfo = 0x00003FE0 }
 
enum  { uppOSLDisposeTokenProcInfo = 0x000000E0 }
 
enum  { uppOSLGetMarkTokenProcInfo = 0x00000FE0 }
 
enum  { uppOSLGetErrDescProcInfo = 0x000000E0 }
 
enum  { uppOSLMarkProcInfo = 0x00000FE0 }
 
enum  { uppOSLAdjustMarksProcInfo = 0x00000FE0 }
 

Functions

typedef CALLBACK_API (OSErr, OSLAccessorProcPtr)(DescType desiredClass
 
typedef CALLBACK_API (OSErr, OSLCompareProcPtr)(DescType oper
 
typedef CALLBACK_API (OSErr, OSLCountProcPtr)(DescType desiredType
 
typedef CALLBACK_API (OSErr, OSLDisposeTokenProcPtr)(AEDesc *unneededToken)
 
typedef CALLBACK_API (OSErr, OSLGetMarkTokenProcPtr)(const AEDesc *dContainerToken
 
typedef CALLBACK_API (OSErr, OSLGetErrDescProcPtr)(AEDesc **appDescPtr)
 
typedef CALLBACK_API (OSErr, OSLMarkProcPtr)(const AEDesc *dToken
 
typedef CALLBACK_API (OSErr, OSLAdjustMarksProcPtr)(long new Start
 
typedef STACK_UPP_TYPE (OSLAccessorProcPtr) OSLAccessorUPP
 
typedef STACK_UPP_TYPE (OSLCompareProcPtr) OSLCompareUPP
 
typedef STACK_UPP_TYPE (OSLCountProcPtr) OSLCountUPP
 
typedef STACK_UPP_TYPE (OSLDisposeTokenProcPtr) OSLDisposeTokenUPP
 
typedef STACK_UPP_TYPE (OSLGetMarkTokenProcPtr) OSLGetMarkTokenUPP
 
typedef STACK_UPP_TYPE (OSLGetErrDescProcPtr) OSLGetErrDescUPP
 
typedef STACK_UPP_TYPE (OSLMarkProcPtr) OSLMarkUPP
 
typedef STACK_UPP_TYPE (OSLAdjustMarksProcPtr) OSLAdjustMarksUPP
 
OSLAccessorUPP NewOSLAccessorUPP (OSLAccessorProcPtr userRoutine)
 
OSLCompareUPP NewOSLCompareUPP (OSLCompareProcPtr userRoutine)
 
OSLCountUPP NewOSLCountUPP (OSLCountProcPtr userRoutine)
 
OSLDisposeTokenUPP NewOSLDisposeTokenUPP (OSLDisposeTokenProcPtr userRoutine)
 
OSLGetMarkTokenUPP NewOSLGetMarkTokenUPP (OSLGetMarkTokenProcPtr userRoutine)
 
OSLGetErrDescUPP NewOSLGetErrDescUPP (OSLGetErrDescProcPtr userRoutine)
 
OSLMarkUPP NewOSLMarkUPP (OSLMarkProcPtr userRoutine)
 
OSLAdjustMarksUPP NewOSLAdjustMarksUPP (OSLAdjustMarksProcPtr userRoutine)
 
void DisposeOSLAccessorUPP (OSLAccessorUPP userUPP)
 
void DisposeOSLCompareUPP (OSLCompareUPP userUPP)
 
void DisposeOSLCountUPP (OSLCountUPP userUPP)
 
void DisposeOSLDisposeTokenUPP (OSLDisposeTokenUPP userUPP)
 
void DisposeOSLGetMarkTokenUPP (OSLGetMarkTokenUPP userUPP)
 
void DisposeOSLGetErrDescUPP (OSLGetErrDescUPP userUPP)
 
void DisposeOSLMarkUPP (OSLMarkUPP userUPP)
 
void DisposeOSLAdjustMarksUPP (OSLAdjustMarksUPP userUPP)
 
OSErr InvokeOSLAccessorUPP (DescType desiredClass, const AEDesc *container, DescType containerClass, DescType form, const AEDesc *selectionData, AEDesc *value, long accessorRefcon, OSLAccessorUPP userUPP)
 
OSErr InvokeOSLCompareUPP (DescType oper, const AEDesc *obj1, const AEDesc *obj2, Boolean *result, OSLCompareUPP userUPP)
 
OSErr InvokeOSLCountUPP (DescType desiredType, DescType containerClass, const AEDesc *container, long *result, OSLCountUPP userUPP)
 
OSErr InvokeOSLDisposeTokenUPP (AEDesc *unneededToken, OSLDisposeTokenUPP userUPP)
 
OSErr InvokeOSLGetMarkTokenUPP (const AEDesc *dContainerToken, DescType containerClass, AEDesc *result, OSLGetMarkTokenUPP userUPP)
 
OSErr InvokeOSLGetErrDescUPP (AEDesc **appDescPtr, OSLGetErrDescUPP userUPP)
 
OSErr InvokeOSLMarkUPP (const AEDesc *dToken, const AEDesc *markToken, long index, OSLMarkUPP userUPP)
 
OSErr InvokeOSLAdjustMarksUPP (long newStart, long newStop, const AEDesc *markToken, OSLAdjustMarksUPP userUPP)
 
OSErr AEObjectInit (void)
 
OSErr AESetObjectCallbacks (OSLCompareUPP myCompareProc, OSLCountUPP myCountProc, OSLDisposeTokenUPP myDisposeTokenProc, OSLGetMarkTokenUPP myGetMarkTokenProc, OSLMarkUPP myMarkProc, OSLAdjustMarksUPP myAdjustMarksProc, OSLGetErrDescUPP myGetErrDescProcPtr)
 
OSErr AEResolve (const AEDesc *objectSpecifier, short callbackFlags, AEDesc *theToken)
 
OSErr AEInstallObjectAccessor (DescType desiredClass, DescType containerType, OSLAccessorUPP theAccessor, long accessorRefcon, Boolean isSysHandler)
 
OSErr AERemoveObjectAccessor (DescType desiredClass, DescType containerType, OSLAccessorUPP theAccessor, Boolean isSysHandler)
 
OSErr AEGetObjectAccessor (DescType desiredClass, DescType containerType, OSLAccessorUPP *accessor, long *accessorRefcon, Boolean isSysHandler)
 
OSErr AEDisposeToken (AEDesc *theToken)
 
OSErr AECallObjectAccessor (DescType desiredClass, const AEDesc *containerToken, DescType containerClass, DescType keyForm, const AEDesc *keyData, AEDesc *token)
 

Detailed Description

Object Support Library Interfaces.

Introduced In: System 8.5
Avaliable From: Universal Interfaces 3.4.1
Copyright: � 1991-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/

Function Documentation

◆ AECallObjectAccessor()

OSErr AECallObjectAccessor ( DescType  desiredClass,
const AEDesc containerToken,
DescType  containerClass,
DescType  keyForm,
const AEDesc keyData,
AEDesc token 
)

AECallObjectAccessor()

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

◆ AEDisposeToken()

OSErr AEDisposeToken ( AEDesc theToken)

AEDisposeToken()

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

◆ AEGetObjectAccessor()

OSErr AEGetObjectAccessor ( DescType  desiredClass,
DescType  containerType,
OSLAccessorUPP *  accessor,
long *  accessorRefcon,
Boolean  isSysHandler 
)

AEGetObjectAccessor()

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

◆ AEInstallObjectAccessor()

OSErr AEInstallObjectAccessor ( DescType  desiredClass,
DescType  containerType,
OSLAccessorUPP  theAccessor,
long  accessorRefcon,
Boolean  isSysHandler 
)

AEInstallObjectAccessor()

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

◆ AEObjectInit()

OSErr AEObjectInit ( void  )

AEObjectInit()

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

◆ AERemoveObjectAccessor()

OSErr AERemoveObjectAccessor ( DescType  desiredClass,
DescType  containerType,
OSLAccessorUPP  theAccessor,
Boolean  isSysHandler 
)

AERemoveObjectAccessor()

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

◆ AEResolve()

OSErr AEResolve ( const AEDesc objectSpecifier,
short  callbackFlags,
AEDesc theToken 
)

AEResolve()

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

◆ AESetObjectCallbacks()

OSErr AESetObjectCallbacks ( OSLCompareUPP  myCompareProc,
OSLCountUPP  myCountProc,
OSLDisposeTokenUPP  myDisposeTokenProc,
OSLGetMarkTokenUPP  myGetMarkTokenProc,
OSLMarkUPP  myMarkProc,
OSLAdjustMarksUPP  myAdjustMarksProc,
OSLGetErrDescUPP  myGetErrDescProcPtr 
)

AESetObjectCallbacks()

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

◆ DisposeOSLAccessorUPP()

void DisposeOSLAccessorUPP ( OSLAccessorUPP  userUPP)
inline

DisposeOSLAccessorUPP()

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

◆ DisposeOSLAdjustMarksUPP()

void DisposeOSLAdjustMarksUPP ( OSLAdjustMarksUPP  userUPP)
inline

DisposeOSLAdjustMarksUPP()

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

◆ DisposeOSLCompareUPP()

void DisposeOSLCompareUPP ( OSLCompareUPP  userUPP)
inline

DisposeOSLCompareUPP()

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

◆ DisposeOSLCountUPP()

void DisposeOSLCountUPP ( OSLCountUPP  userUPP)
inline

DisposeOSLCountUPP()

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

◆ DisposeOSLDisposeTokenUPP()

void DisposeOSLDisposeTokenUPP ( OSLDisposeTokenUPP  userUPP)
inline

DisposeOSLDisposeTokenUPP()

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

◆ DisposeOSLGetErrDescUPP()

void DisposeOSLGetErrDescUPP ( OSLGetErrDescUPP  userUPP)
inline

DisposeOSLGetErrDescUPP()

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

◆ DisposeOSLGetMarkTokenUPP()

void DisposeOSLGetMarkTokenUPP ( OSLGetMarkTokenUPP  userUPP)
inline

DisposeOSLGetMarkTokenUPP()

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

◆ DisposeOSLMarkUPP()

void DisposeOSLMarkUPP ( OSLMarkUPP  userUPP)
inline

DisposeOSLMarkUPP()

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

◆ InvokeOSLAccessorUPP()

OSErr InvokeOSLAccessorUPP ( DescType  desiredClass,
const AEDesc container,
DescType  containerClass,
DescType  form,
const AEDesc selectionData,
AEDesc value,
long  accessorRefcon,
OSLAccessorUPP  userUPP 
)
inline

InvokeOSLAccessorUPP()

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

◆ InvokeOSLAdjustMarksUPP()

OSErr InvokeOSLAdjustMarksUPP ( long  newStart,
long  newStop,
const AEDesc markToken,
OSLAdjustMarksUPP  userUPP 
)
inline

InvokeOSLAdjustMarksUPP()

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

◆ InvokeOSLCompareUPP()

OSErr InvokeOSLCompareUPP ( DescType  oper,
const AEDesc obj1,
const AEDesc obj2,
Boolean result,
OSLCompareUPP  userUPP 
)
inline

InvokeOSLCompareUPP()

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

◆ InvokeOSLCountUPP()

OSErr InvokeOSLCountUPP ( DescType  desiredType,
DescType  containerClass,
const AEDesc container,
long *  result,
OSLCountUPP  userUPP 
)
inline

InvokeOSLCountUPP()

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

◆ InvokeOSLDisposeTokenUPP()

OSErr InvokeOSLDisposeTokenUPP ( AEDesc unneededToken,
OSLDisposeTokenUPP  userUPP 
)
inline

InvokeOSLDisposeTokenUPP()

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

◆ InvokeOSLGetErrDescUPP()

OSErr InvokeOSLGetErrDescUPP ( AEDesc **  appDescPtr,
OSLGetErrDescUPP  userUPP 
)
inline

InvokeOSLGetErrDescUPP()

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

◆ InvokeOSLGetMarkTokenUPP()

OSErr InvokeOSLGetMarkTokenUPP ( const AEDesc dContainerToken,
DescType  containerClass,
AEDesc result,
OSLGetMarkTokenUPP  userUPP 
)
inline

InvokeOSLGetMarkTokenUPP()

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

◆ InvokeOSLMarkUPP()

OSErr InvokeOSLMarkUPP ( const AEDesc dToken,
const AEDesc markToken,
long  index,
OSLMarkUPP  userUPP 
)
inline

InvokeOSLMarkUPP()

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

◆ NewOSLAccessorUPP()

OSLAccessorUPP NewOSLAccessorUPP ( OSLAccessorProcPtr  userRoutine)
inline

NewOSLAccessorUPP()

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

◆ NewOSLAdjustMarksUPP()

OSLAdjustMarksUPP NewOSLAdjustMarksUPP ( OSLAdjustMarksProcPtr  userRoutine)
inline

NewOSLAdjustMarksUPP()

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

◆ NewOSLCompareUPP()

OSLCompareUPP NewOSLCompareUPP ( OSLCompareProcPtr  userRoutine)
inline

NewOSLCompareUPP()

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

◆ NewOSLCountUPP()

OSLCountUPP NewOSLCountUPP ( OSLCountProcPtr  userRoutine)
inline

NewOSLCountUPP()

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

◆ NewOSLDisposeTokenUPP()

OSLDisposeTokenUPP NewOSLDisposeTokenUPP ( OSLDisposeTokenProcPtr  userRoutine)
inline

NewOSLDisposeTokenUPP()

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

◆ NewOSLGetErrDescUPP()

OSLGetErrDescUPP NewOSLGetErrDescUPP ( OSLGetErrDescProcPtr  userRoutine)
inline

NewOSLGetErrDescUPP()

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

◆ NewOSLGetMarkTokenUPP()

OSLGetMarkTokenUPP NewOSLGetMarkTokenUPP ( OSLGetMarkTokenProcPtr  userRoutine)
inline

NewOSLGetMarkTokenUPP()

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

◆ NewOSLMarkUPP()

OSLMarkUPP NewOSLMarkUPP ( OSLMarkProcPtr  userRoutine)
inline

NewOSLMarkUPP()

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