stringFormat

This function is used by Ignition's Expression language.

Description

Returns a formatted string using the specified format string and arguments.

Syntax

stringFormat(format[, args...])

• Parameters

  • string format - A string that contains formatting elements in it (%s, %d, %i).

    string args - Optional. The arguments to use in the format. Must match the number of formatting elements in the string.

• Results

  • string - The new formatted string.

Examples

Code Snippet

stringFormat("Hello %s", "world") //returns "Hello world"

Code Snippet

stringFormat("%s, %s, %s", 1, 2, 3) //returns "1, 2, 3"

Code Snippet

stringFormat("%d, %d, %d", 4, 5, 6) //returns "4, 5, 6"