Automator Constants Reference

Framework
Automator.framework
Declared in
AutomatorErrors.h

Overview

This document defines constants in the Automator framework that are not associated with a particular class.

Constants

Enumerations

NSError Codes

NSError codes in the Automator error domain.

   
enum {
   
   // Workflow errors
   AMWorkflowNewerVersionError = -100,
   AMWorkflowPropertyListInvalidError = -101,
   AMWorkflowNewerActionVersionError = -111,
   AMWorkflowOlderActionVersionError = -112,
   
   // Workflow runtime errors
   AMUserCanceledError = -128,
   
   // Action errors
   AMNoSuchActionError = -200,
   AMActionNotLoadableError = -201,
   AMActionArchitectureMismatchError = -202,
   AMActionRuntimeMismatchError = -203,
   AMActionLoadError = -204,
   AMActionLinkError = -205,
   AMActionApplicationResourceError = -206,
   AMActionApplicationVersionResourceError = -207,
   AMActionFileResourceError = -208,
   AMActionLicenseResourceError = -209,
   AMActionRequiredActionResourceError = -210,
   AMActionInitializationError = -211,
   AMActionExecutionError = -212,
   AMActionExceptionError = -213,
   AMActionPropertyListInvalidError = -214,
   AMActionInsufficientDataError = -215,
   AMActionIsDeprecatedError = -216,
   
   // Data conversion errors
   AMConversionNotPossibleError = -300,
   AMConversionNoDataError = -301,
   AMConversionFailedError = -302
};
Constants
AMWorkflowNewerVersionError

Attempt to open a workflow document that was saved with a newer version of Automator.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMWorkflowPropertyListInvalidError

Attempt to open a workflow document whose property list (document.wflow) could not be read; the property list document could be missing, damaged, or constructed improperly.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMWorkflowNewerActionVersionError

An action in a workflow is newer than the installed action; this error is presented to the user as a warning.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMWorkflowOlderActionVersionError

An action in a workflow is older than the installed action; this error is presented to the user as a warning.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMUserCanceledError

The user cancelled. This error is the same as the AppleScript error userCanceledErr, defined in MacErrors.h. When an Apple Event is canceled by the user, a running action may return this error. Automator ignores the error and stops the workflow gracefully, without displaying the error to the user.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMNoSuchActionError

The action could not be located on the system.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionNotLoadableError

The action's executable is of a type that is not loadable in the current process. If the action uses a custom subclass of AMBundleAction or AMAppleScriptAction, then the most likely problem is that the bundle's executable is missing or the NSPrincipleClass is not set in the Info.plist. Users are likely to be confused by a “missing bundle” error, so Automator presents it as the more generic “action not loadable” error.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionArchitectureMismatchError

The action's binary is not compatible with the current processor; actions compiled for PowerPC, for example, would encounter this error on Intel systems.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionRuntimeMismatchError

An attempt was made to load an action that is not compiled in a way that is compatible with the current application; for example, the action may be compiled for 32-bit applications or it may not be compatible with garbage collection.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionLoadError

The action's executable failed to load; for example, there may have been a problem with a library it depends on.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionLinkError

The action's executable failed to load due to linking issues.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionApplicationResourceError

An application required by the action is not found.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionApplicationVersionResourceError

An application required by the action is the wrong version.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionFileResourceError

A file required by the action is not found.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionLicenseResourceError

A license required by the action was not found. The only license currently supported is QuickTime Pro.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionRequiredActionResourceError

An action required by the action is not loaded.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionInitializationError

Automator is unable to initialize an action (reason unknown).

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionExecutionError

An action encounters an error while running.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionExceptionError

An action encounters an exception while running.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionPropertyListInvalidError

The property list (Info.plist) for an action is invalid; it could be missing, damaged, or constructed improperly.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionInsufficientDataError

The action requires input data to run, but none was supplied.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionIsDeprecatedError

The action has been deprecated. Use a replacement action, if available.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMConversionNotPossibleError

The converter determines that it is unable to convert from one data type to another. Not displayed to the user.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMConversionNoDataError

The converter determines that a given conversion, though possible, would produce a nil result. Not displayed to the user.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMConversionFailedError

Occurs when, for example, the converter encounters an error converting data from one type to another.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

Discussion

The constants in this enumeration are NSError code numbers in the Automator error domain (AMAutomatorErrorDomain). You’ll obtain these error codes from the instances of NSError returned, for example, by certain methods of AMWorkflow and AMWorkflowController. For related information, see AMActionErrorKey.

Declared In
AutomatorErrors.h

Constants

Automator Constants

These constants are used in the Automator framework.

#define AMAutomatorErrorDomain @"com.apple.Automator"
#define AMActionErrorKey       @"AMActionErrorKey"
Constants
AMAutomatorErrorDomain

This constant defines the Automator error domain.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

AMActionErrorKey

Use this key to obtain, from the userInfo dictionary of an instance of NSError, a reference to the action (class AMAction) that caused the error.

Available in OS X v10.5 and later.

Declared in AutomatorErrors.h.

Declared In
AutomatorErrors.h