CLIENTSUBSTITUTE

Creates a string combined of literal values and replacements for which values are substituted at run time. CLIENTSUBSTITUTE ( ) allows inclusion of literal commas and parentheses in the string.

Return Value

String

Syntax

CLIENTSUBSTITUTE( pattern {, arg} ... )

where:

• pattern is evaluated into a string.
• Each arg is evaluated into a string, passed through WinStudio literal massaging, which converts commas and parentheses into special characters, and, unless the argument consists of an embedded STRINGS() or FORMAT() call, is wrapped in ~LIT~(arg).
• The resulting strings are separated by commas, in the same order given, and wrapped in a FORMAT( ) statement.

This allows the presence of commas and/or parentheses within the arguments. The system can still parse the arguments as originally separated.

You can concatenate the string that results from evaluating the CLIENTSUBSTITUTE( ) expression with other strings. You can pass the string to SUBSTITUTE in order to build a larger expression, for example, BODY( ), that contains the unchanged ~LIT~( ) expressions.