VirtualArray.Format(String, String) Method

Top

Description

Converts the numeric values contained within the calling VirtualArray into a string based on the format specifiers given by formatString. The format specifiers are standard C/C++ specifiers as used with the sprintf function. The Format method converts a double precision floating point value to a string; the IFormat method should be used to convert an integer value to a string. Array elements will be delimited using delimiter.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

VirtualArray.Format(	String formatString,
	String delimiter)

Arguments

formatString
Description:	Format specifier to use when converting the calling VirtualArray into a String. The format specifiers are standard C/C++ specifiers as used with the sprintf function.

delimiter
Description:	Delimiter to use when converting the calling VirtualArray into a String. This argument will be used to delimit elements of the calling VirtualArray.

Return Value

Type:

string

Returns a String containing the converted version of the calling VirtualArray.

Syntax

myString1 = {1,2,3,4}.Format(myString2, myString3);