AECreateAppleEvent(_:_:_:_:_:_:)

Declaration

func AECreateAppleEvent(_ theAEEventClass: AEEventClass, _ theAEEventID: AEEventID, _ target: UnsafePointer<AEAddressDesc>!, _ returnID: AEReturnID, _ transactionID: AETransactionID, _ result: UnsafeMutablePointer<AppleEvent>!) -> OSErr

Parameters

• theAEEventClass:

  The event class of the Apple event to create. This parameter becomes accessible through the keyEventClassAttr attribute of the Apple event. Some event classes are described in 1527210 Event_class_constants. See Aeeventclass.

• theAEEventID:

  The event ID of the Apple event to create. This parameter becomes accessible through the keyEventIDAttr attribute of the Apple event. Some event IDs are described in 1527223 Event_id_constants. See Aeeventid.

• target:

  A pointer to an address descriptor. Before calling AECreateAppleEvent, you set the descriptor to identify the target (or server) application for the Apple event. This parameter becomes accessible through the keyAddressAttr attribute of the Apple event. See Aeaddressdesc.

• returnID:

  The return ID for the created Apple event. If you pass a value of kAutoGenerateReturnID, the Apple Event Manager assigns the created Apple event a return ID that is unique to the current session. If you pass any other value, the Apple Event Manager assigns that value for the ID. This parameter becomes accessible through the keyReturnIDAttr attribute of the Apple event. The return ID constant is described in 1542799 Id_constants_for_the_aecreateapp. See Aereturnid.

• transactionID:

  The transaction ID for this Apple event. A transaction is a sequence of Apple events that are sent back and forth between the client and server applications, beginning with the client’s initial request for a service. All Apple events that are part of a transaction must have the same transaction ID. You can specify the kAnyTransactionID constant if the Apple event is not one of a series of interdependent Apple events. This parameter becomes accessible through the keyTransactionIDAttr attribute of the Apple event. This transaction ID constant is described in 1542799 Id_constants_for_the_aecreateapp. See Aetransactionid.

• result:

  A pointer to an Apple event. On successful return, the new Apple event. On error, a null descriptor (one with descriptor type typeNull). If the function returns successfully, your application should call the 1444208 Aedisposedesc function to dispose of the resulting Apple event after it has finished using it. See the Appleevent data type.

Return Value

A result code. See Result Codes.

Discussion

The AECreateAppleEvent function creates an empty Apple event. You can add parameters to the Apple event after you create it with the functions described in Apple Event Manager.

Version-Notes

Thread safe starting in OS X v10.2.