Format

The Format function returns a formatted string, as a result of the replacement of the placeholders in the composite format string with the string representation of the corresponding parameters.

Prototype

  Format(String ; Parameter)

Arguments

  String                     String                     By value   `One Or More Parameters`

  The String containing the composite format string. The placeholders are specified using the notation {n} 
  where 'n' is a sequential number starting from 0, that identifies the corresponding item in the list of 
  parameters.


  Parameter                  Any                        By Value 

  A list of parameters separated by semicolon (;) that will be used to fill the placeholders in the composite
  format string. The parameter can be a literal, the result of an expression or a variable (Studio only).

Returns

String

The formatted string 

Exception

Undefined

Undefined is returned if Parameter is Undefined.

Examples

Format('Element {0} RecMass={1}' ; {Name}; "o_Rec_Mass" )

This returns a formatted string like Element tk_C4 RecMass=1862.067252998.