CasewareDocs

FormatMessage

Formats a string using the specified arguments.

Compatibility

Available as of IDEA version 9.1.1

Syntax

FormatMessage(message as String, Optional args)

Parameters

message

The format (with indexed placeholders) message. An exeption is thrown if message is null.

args

The arguments for formatting the message.

Return Value

A string. If the array args is null or empty the function returns message.

In case a FormatException is thrown by string.Format the function composes a standard message that includes a reference to message and the string representation of the arguments.

Example

Sub Main 
Dim msg As String
msg = SmartContext.Log.FormatMessage("Msg: {0}, {1}, {2}", "abc", True, 2417375)
End Sub