vAEBuildDesc(_:_:_:_:)
Allows you to encapsulate calls to AEBuildDesc in your own wrapper routines.
Declaration
func vAEBuildDesc(_ dst: UnsafeMutablePointer<AEDesc>!, _ error: UnsafeMutablePointer<AEBuildError>!, _ src: UnsafePointer<CChar>!, _ args: CVaListPointer) -> OSStatusParameters
- dst:
A pointer to a descriptor where the resulting descriptor should be stored. See Aedesc.
- error:
A pointer to an
AEBuildErrorstructure where additional information about any errors that occur will be saved. This is an optional parameter and you can passNULLif this information is not required. See Aebuilderror. - src:
An
AEBuildformat string describing the descriptor 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 theva_listdata type.
Return Value
A numeric result code indicating the success of the call. A value of AEBuildSyntaxNoErr (zero) means the call succeeded. You can use the error parameter to discover information about other errors. See Result Codes.
Discussion
Passing an argument list to vAEBuildDesc corresponds to passing a series of individual parameters to the AEBuildDesc 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 vAEBuildDesc 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.