Utility_SubstituteTokens()

Examples


The Utility_SubstituteTokens() function replaces product tokens in a string with the corresponding product names.

Syntax

Utility_SubstituteTokens(string)

Parameters

string – The string in which tokens will be substituted.

Return value

A string in which product tokens have been substituted.

Comments

Rather than hard-coding product names in strings, we recommend that you use tokens to represent product names. The token to indicate the product name in a string is @PRODprodID@ where prodID is the product ID of the product whose name you want to include in the message. The product name will be read automatically from the launch file.

If the token specifies a product for which a product name cannot be found, the string [unknown] is substituted.


Documentation Feedback