vAEBuildParameters(_:_:_:_:)

Declaration

func vAEBuildParameters(_ event: UnsafeMutablePointer<AppleEvent>!, _ error: UnsafeMutablePointer<AEBuildError>!, _ format: UnsafePointer<CChar>!, _ args: CVaListPointer) -> OSStatus

Parameters

• event:

  The Apple event to which you are adding parameters. See Appleevent.

• error:

  A pointer to an AEBuildError structure where additional information about any errors that occur will be saved. This is an optional parameter and you can pass NULL if this information is not required. See Aebuilderror.

• format:

  An AEBuild format string describing the AEDesc parameters to be created.

• args:

  A reference to a previously defined, variable argument parameter list to use with the descriptor-string. The file <stdarg.h> defines macros for declaring and using the va_list data type.

Return Value

A result code. See Result Codes.

Discussion

Passing an argument list to vAEBuildParameters corresponds to passing a series of individual parameters to the AEBuildParameters function.

This function and related “AEBuild” routines provide a very simple translation service for converting specially formatted strings into complex Apple event descriptors. Normally, creating complex Apple event descriptors requires a large number of calls to Apple event Manager routines to build up the descriptor piece by piece. The vAEBuildParameters function and related routines allow you to consolidate all of the calls required to construct a complex Apple event descriptor into a single system call that creates the desired structure as directed by a format string that you provide.

See Also

Creating Apple Event Structures in Memory

• AEPrintDescToHandle(_:_:)
• vAEBuildAppleEvent(_:_:_:_:_:_:_:_:_:_:_:)
• vAEBuildDesc(_:_:_:_:)