AXUIElementCopyActionDescription(_:_:_:)

Declaration

func AXUIElementCopyActionDescription(_ element: AXUIElement, _ action: CFString, _ description: UnsafeMutablePointer<CFString?>) -> AXError

Parameters

• element:

  The AXUIElementRef representing the accessibility object.

• action:

  The action to be described.

• description:

  On return, a string containing the description of the action.

Return Value

If unsuccessful, AXUIElementCopyActionDescription may return one of the following error codes, among others:

kAXErrorActionUnsupported

The specified AXUIElementRef does not support the specified action (you will also receive this error if you pass in the system-wide accessibility object).

kAXErrorIllegalArgument

One or more of the arguments is an illegal value.

kAXErrorInvalidUIElement

The AXUIElementRef is invalid.

kAXErrorCannotComplete

The function cannot complete because messaging has failed in some way.

kAXErrorNotImplemented

The process does not fully support the accessibility API.

See Also

Miscellaneous

• AXIsProcessTrusted()
• AXIsProcessTrustedWithOptions(_:)
• AXUIElementCopyActionNames(_:_:)
• AXUIElementCopyAttributeNames(_:_:)
• AXUIElementCopyAttributeValue(_:_:_:)
• AXUIElementCopyAttributeValues(_:_:_:_:_:)
• AXUIElementCopyElementAtPosition(_:_:_:_:)
• AXUIElementCopyMultipleAttributeValues(_:_:_:_:)
• AXUIElementCopyParameterizedAttributeNames(_:_:)
• AXUIElementCopyParameterizedAttributeValue(_:_:_:_:)
• AXUIElementCreateApplication(_:)
• AXUIElementCreateSystemWide()
• AXUIElementGetAttributeValueCount(_:_:_:)
• AXUIElementGetPid(_:_:)
• AXUIElementGetTypeID()
• AXUIElementIsAttributeSettable(_:_:_:)
• AXUIElementPerformAction(_:_:)
• AXUIElementSetAttributeValue(_:_:_:)
• AXUIElementSetMessagingTimeout(_:_:)