AEStreamOptionalParam(_:_:)

Declaration

func AEStreamOptionalParam(_ ref: AEStreamRef!, _ key: AEKeyword) -> OSStatus

Parameters

• ref:

  An Aestreamref containing the stream data.

• key:

  The AEKeyword associated with any keyword/descriptor pair in an Apple event. See Aekeyword.

Return Value

A result code. See Result Codes.

Discussion

Calls to this routine must be preceded by a call to either AEStreamCreateEvent(_:_:_:_:_:_:_:) or AEStreamOpenEvent(_:).

The descriptor associated with the specified key does not need to exist before you call this routine.

See Also

Creating Apple Event Structures Using Streams

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