AEStreamOpenEvent(_:)

Declaration

func AEStreamOpenEvent(_ event: UnsafeMutablePointer<AppleEvent>!) -> AEStreamRef!

Parameters

• event:

  An existing Apple event. See Appleevent.

Return Value

An AEStreamRef for the Apple event or NULL if the stream data structures could not be allocated.

Discussion

Use this function to open a stream and add parameters to an existing Apple event. This function copies any parameters already in the Apple event to the stream prior to returning the AEStreamRef. When you are done adding parameters, use AEStreamClose(_:_:) to save them to the Apple event and close the stream.

If there is not enough available storage to complete the operation, AEStreamOpenEvent returns NULL and leaves the Apple event unchanged.

See Also

Creating Apple Event Structures Using Streams

• AEStreamClose(_:_:)
• AEStreamCloseDesc(_:)
• AEStreamCloseList(_:)
• AEStreamCloseRecord(_:)
• AEStreamCreateEvent(_:_:_:_:_:_:_:)
• AEStreamOpen()
• AEStreamOpenDesc(_:_:)
• AEStreamOpenKeyDesc(_:_:_:)
• AEStreamOpenList(_:)
• AEStreamOpenRecord(_:_:)
• AEStreamOptionalParam(_:_:)
• AEStreamSetRecordType(_:_:)
• AEStreamWriteAEDesc(_:_:)
• AEStreamWriteData(_:_:_:)
• AEStreamWriteDesc(_:_:_:_:)
• AEStreamWriteKey(_:_:)
• AEStreamWriteKeyDesc(_:_:_:_:_:)