Apple Event Manager Reference (Legacy) Contents
Total Page:16
File Type:pdf, Size:1020Kb
Apple Event Manager Reference (Legacy) Contents Apple Event Manager Reference (Legacy) 12 Overview 12 Functions by Task 13 Adding Items to Descriptor Lists 13 Adding Parameters and Attributes to Apple Events and Apple Event Records 13 Coercing Descriptor Types 14 Counting the Items in Descriptor Lists 14 Creating an Apple Event 14 Creating and Duplicating Descriptors 14 Creating, Calling, and Deleting Universal Procedure Pointers 15 Creating Descriptor Lists and Apple Event Records 17 Creating Object Specifiers 17 Deallocating Memory for Descriptors 18 Deallocating Memory for Tokens 18 Deleting Descriptors 18 Dispatching Apple Events 18 Getting, Calling, and Removing Object Accessor Functions 19 Getting Data or Descriptors From Apple Events and Apple Event Records 19 Getting Information About the Apple Event Manager 19 Getting Items From Descriptor Lists 20 Getting the Sizes and Descriptor Types of Descriptors 20 Initializing the Object Support Library 20 Locating Processes on Remote Computers 20 Managing Apple Event Dispatch Tables 21 Managing Coercion Handler Dispatch Tables 21 Managing Special Handler Dispatch Tables 21 Operating On Descriptor Data 22 Requesting More Time to Respond to Apple Events 22 Requesting User Interaction 22 Resolving Object Specifiers 23 Sending an Apple Event 23 Creating Apple Event Structures in Memory 23 Creating Apple Event Structures Using Streams 23 Working With Lower Level Apple Event Functions 25 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 2 Contents Serializing Apple Event Data 25 Suspending and Resuming Apple Event Handling 25 Miscellaneous 26 Functions 26 AEBuildAppleEvent 26 AEBuildDesc 28 AEBuildParameters 30 AECallObjectAccessor 31 AECheckIsRecord 32 AECoerceDesc 33 AECoercePtr 34 AECountItems 35 AECreateAppleEvent 36 AECreateDesc 38 AECreateDescFromExternalPtr 39 AECreateList 41 AECreateRemoteProcessResolver 43 AEDecodeMessage 44 AEDeleteItem 45 AEDeleteKeyDesc 45 AEDeleteParam 46 AEDisposeDesc 47 AEDisposeRemoteProcessResolver 48 AEDisposeToken 49 AEDuplicateDesc 50 AEFlattenDesc 51 AEGetArray 52 AEGetAttributeDesc 54 AEGetAttributePtr 55 AEGetCoercionHandler 57 AEGetDescData 59 AEGetDescDataRange 60 AEGetDescDataSize 61 AEGetEventHandler 62 AEGetInteractionAllowed 63 AEGetKeyDesc 64 AEGetKeyPtr 65 AEGetNthDesc 66 AEGetNthPtr 68 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 3 Contents AEGetObjectAccessor 70 AEGetParamDesc 72 AEGetParamPtr 73 AEGetRegisteredMachPort 76 AEGetSpecialHandler 76 AEGetTheCurrentEvent 77 AEInitializeDesc 78 AEInstallCoercionHandler 79 AEInstallEventHandler 81 AEInstallObjectAccessor 83 AEInstallSpecialHandler 84 AEInteractWithUser 86 AEManagerInfo 87 AEObjectInit 89 AEPrintDescToHandle 89 AEProcessAppleEvent 90 AEProcessMessage 92 AEPutArray 93 AEPutAttributeDesc 95 AEPutAttributePtr 96 AEPutDesc 97 AEPutKeyDesc 98 AEPutKeyPtr 99 AEPutParamDesc 100 AEPutParamPtr 101 AEPutPtr 102 AERemoteProcessResolverGetProcesses 103 AERemoteProcessResolverScheduleWithRunLoop 104 AERemoveCoercionHandler 105 AERemoveEventHandler 106 AERemoveObjectAccessor 108 AERemoveSpecialHandler 109 AEReplaceDescData 111 AEResetTimer 111 AEResolve 112 AEResumeTheCurrentEvent 114 AESend 116 AESendMessage 118 AESetInteractionAllowed 120 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 4 Contents AESetObjectCallbacks 121 AESetTheCurrentEvent 123 AESizeOfAttribute 124 AESizeOfFlattenedDesc 124 AESizeOfKeyDesc 125 AESizeOfNthItem 126 AESizeOfParam 127 AEStreamClose 128 AEStreamCloseDesc 129 AEStreamCloseList 129 AEStreamCloseRecord 130 AEStreamCreateEvent 131 AEStreamOpen 132 AEStreamOpenDesc 133 AEStreamOpenEvent 133 AEStreamOpenKeyDesc 134 AEStreamOpenList 135 AEStreamOpenRecord 136 AEStreamOptionalParam 137 AEStreamSetRecordType 137 AEStreamWriteAEDesc 138 AEStreamWriteData 139 AEStreamWriteDesc 140 AEStreamWriteKey 141 AEStreamWriteKeyDesc 141 AESuspendTheCurrentEvent 143 AEUnflattenDesc 144 CreateCompDescriptor 145 CreateLogicalDescriptor 146 CreateObjSpecifier 147 CreateOffsetDescriptor 148 CreateRangeDescriptor 149 DisposeAECoerceDescUPP 150 DisposeAECoercePtrUPP 151 DisposeAEDisposeExternalUPP 151 DisposeAEEventHandlerUPP 151 DisposeAEFilterUPP 152 DisposeAEIdleUPP 152 DisposeOSLAccessorUPP 153 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 5 Contents DisposeOSLAdjustMarksUPP 153 DisposeOSLCompareUPP 154 DisposeOSLCountUPP 154 DisposeOSLDisposeTokenUPP 155 DisposeOSLGetErrDescUPP 155 DisposeOSLGetMarkTokenUPP 155 DisposeOSLMarkUPP 156 InvokeAECoerceDescUPP 156 InvokeAECoercePtrUPP 157 InvokeAEDisposeExternalUPP 157 InvokeAEEventHandlerUPP 158 InvokeAEFilterUPP 159 InvokeAEIdleUPP 159 InvokeOSLAccessorUPP 160 InvokeOSLAdjustMarksUPP 161 InvokeOSLCompareUPP 161 InvokeOSLCountUPP 162 InvokeOSLDisposeTokenUPP 162 InvokeOSLGetErrDescUPP 163 InvokeOSLGetMarkTokenUPP 163 InvokeOSLMarkUPP 164 NewAECoerceDescUPP 164 NewAECoercePtrUPP 165 NewAEDisposeExternalUPP 165 NewAEEventHandlerUPP 166 NewAEFilterUPP 166 NewAEIdleUPP 167 NewOSLAccessorUPP 168 NewOSLAdjustMarksUPP 168 NewOSLCompareUPP 169 NewOSLCountUPP 169 NewOSLDisposeTokenUPP 170 NewOSLGetErrDescUPP 170 NewOSLGetMarkTokenUPP 171 NewOSLMarkUPP 171 vAEBuildAppleEvent 172 vAEBuildDesc 174 vAEBuildParameters 175 Callbacks by Task 176 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 6 Contents Callbacks When Resolving Remote Processes 176 Callbacks When Creating Apple Events 176 Callbacks When Sending Apple Events 176 Coercing Apple Event Data Callbacks 177 Handling Apple Events Callbacks 177 Object Accessor Callbacks 177 Object Callback Functions 177 Callbacks 178 AECoerceDescProcPtr 178 AECoercePtrProcPtr 180 AEDisposeExternalProcPtr 182 AEEventHandlerProcPtr 183 AEFilterProcPtr 185 AEIdleProcPtr 187 AERemoteProcessResolverCallback 189 OSLAccessorProcPtr 189 OSLAdjustMarksProcPtr 192 OSLCompareProcPtr 194 OSLCountProcPtr 196 OSLDisposeTokenProcPtr 198 OSLGetErrDescProcPtr 200 OSLGetMarkTokenProcPtr 201 OSLMarkProcPtr 203 Data Types 205 AEArrayData 205 AEBuildError 206 AEDesc 206 AEKeyDesc 207 AERemoteProcessResolverContext 208 ccntTokenRecord 209 IntlText 210 OffsetArray 210 TextRange 211 TextRangeArray 211 TScriptingSizeResource 212 WritingCode 212 AEAddressDesc 212 AEArrayDataPointer 213 AEArrayType 213 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 7 Contents AECoerceDescUPP 214 AECoercePtrUPP 214 AECoercionHandlerUPP 215 AEDataStorage 215 AEDataStorageType 216 AEDescList 216 AEEventSource 217 AEDisposeExternalUPP 217 AEEventClass 218 AEEventHandlerUPP 218 AEEventID 219 AEFilterUPP 219 AEIdleUPP 220 AEKeyword 220 AERecord 220 AERemoteProcessResolverRef 221 AEReturnID 222 AESendOptions 222 AESendPriority 222 AEStreamRef 223 AETransactionID 223 AppleEvent 223 DescType 224 OffsetArrayHandle 225 OSLAccessorUPP 225 OSLAdjustMarksUPP 225 OSLCompareUPP 226 OSLCountUPP 226 OSLDisposeTokenUPP 226 OSLGetErrDescUPP 227 OSLGetMarkTokenUPP 227 OSLMarkUPP 228 AEInteractAllowed 228 Constants 228 AEBuild Error Codes 228 AESendMode 231 Apple Event Recording Event ID Constants 236 cAEList 238 Callback Constants for the AEResolve Function 238 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 8 Contents cInsertionLoc 239 cKeystroke 240 Comparison Operator Constants 241 Constants for Object Specifiers, Positions, and Logical and Comparison Operations 242 cURL 248 cVersion 248 Data Array Constants 249 Descriptor Type Constants 250 eScheme 254 Event Class Constants 255 Event Handler Flags 256 Event ID Constants 256 Event Source Constants 258 Factoring Constants 259 ID Constants for the AECreateAppleEvent Function 260 Key Form and Descriptor Type Object Specifier Constants 260 Keyword Attribute Constants 264 Keyword Parameter Constants 267 Launch Apple Event Constants 268 Numeric Descriptor Type Constants 269 Object Class ID Constants 271 Other Descriptor Type Constants 273 Priority Constants for the AESend Function (Deprecated in Mac OS X) 274 Remote Process Dictionary Keys 274 Resume Event Dispatch Constants 275 Special Handler Callback Constants 276 Timeout Constants 277 User Interaction Level Constants 278 Whose Test Constants 279 kAEDoObjectsExist 280 kAEDebugPOSTHeader 281 kAEGetPrivilegeSelection 281 kAEHandleArray 282 kAEInfo 282 kAEInternetSuite 283 kAEISGetURL 283 kAEISHTTPSearchArgs 283 kAELogOut 283 kAEMenuClass 284 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 9 Contents kAEMouseClass 284 kAENonmodifiable 285 kAEQDNotOr 285 kAESetPosition 286 kAESocks4Protocol 286 kAEUseHTTPProxyAttr 286 kAEUserTerminology 287 kAEUseSocksAttr 287 kAEUTHasReturningParam 288 kAEZoomIn 288 kBySmallIcon 288 kCaretPosition 289 kConnSuite 289 keyAEAngle 291 keyAEBaseAddr 291 keyAEDoScale 292 keyAEHiliteRange 292 keyAEKeyword 293 keyAELeadingEdge 293 keyAEPropData 293 keyAESuiteID 294 keyMenuID 295 keyMiscellaneous 295 keyReplyPortAttr 295 keySOAPStructureMetaData 296 keyUserNameAttr 296 kFAServerApp 296 kLaunchToGetTerminology 297 kNextBody 297 kOSIZDontOpenResourceFile 297 kReadExtensionTermsMask 297 kSOAP1999Schema 298 kTextServiceClass 298 kTSMHiliteCaretPosition 299 kTSMOutsideOfBody 300 pArcAngle 300 pFormula 301 pNewElementLoc 302 pScheme 302 Retired Document | 2007-07-13 | Copyright © 1993, 2007 Apple Inc. All Rights Reserved. 10 Contents pTextStyles 302 typeAEText 303 typeApplicationBundleID 303 typeFinderWindow 304 typeHIMenu 304 typeKernelProcessID