Success

Success["tag",assoc]

represents a success of a type indicated by tag, with details given by the association assoc.

Details

  • Success[…]["prop"] extracts a property from a Success object. Success[…][{key1,key2,…}] extracts a list of values. »
  • Success[…]["Properties"] returns a list of available properties. »
  • The association assoc typically contains:
  • "MessageTemplate"a string template for a message
    "MessageParameters"parameters to use for the message template
  • The parameters are effectively inserted into the message template using TemplateApply.
  • With the entry "MessageTemplate":>symb::name, a message name can be stored for use when a message is generated.
  • Success is generated by SendMail, EntityPrefetch and other functions that typically do not produce an output directly related to the evaluation being performed.

Examples

open allclose all

Basic Examples  (1)

Create a Success expression with a given tag and association:

Scope  (4)

Success can have any number of keys in its association:

Indicate success using a message template and positional parameters:

Create a Success expression with a given tag and association:

Get a list of all the available properties:

Extract a single property:

Extract multiple properties:

Properties & Relations  (3)

Success is returned by functions like SendMail and EntityPrefetch:

The opposite of Success is Failure:

Only the first two keys are shown in the typeset form when closed:

If a "MessageTemplate" is provided, it always appears first:

When opened, all keys and the tag are displayed:

Wolfram Research (2018), Success, Wolfram Language function, https://reference.wolfram.com/language/ref/Success.html.

Text

Wolfram Research (2018), Success, Wolfram Language function, https://reference.wolfram.com/language/ref/Success.html.

CMS

Wolfram Language. 2018. "Success." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/Success.html.

APA

Wolfram Language. (2018). Success. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/Success.html

BibTeX

@misc{reference.wolfram_2024_success, author="Wolfram Research", title="{Success}", year="2018", howpublished="\url{https://reference.wolfram.com/language/ref/Success.html}", note=[Accessed: 24-November-2024 ]}

BibLaTeX

@online{reference.wolfram_2024_success, organization={Wolfram Research}, title={Success}, year={2018}, url={https://reference.wolfram.com/language/ref/Success.html}, note=[Accessed: 24-November-2024 ]}