Matrix.Format(String, String, String) Method

Top

Description

Converts the numeric values contained within the calling Matrix 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. Matrix rows and columns will be delimited using the provided format specifiers.

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

Matrix.Format(	String formatString,
	String columnDelimiter,
	String rowDelimiter)

Arguments

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

columnDelimiter
Description:	Column delimiter to use when converting the calling Matrix into a String. This argument will be used to delimit columns of the calling Matrix.

rowDelimiter
Description:	Row delimiter to use when converting the calling Matrix into a String. This argument will be used to delimit rows of the calling Matrix.

Return Value

Type:

string

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

Syntax

myString1 = myMatrix1.Format(myString2, myString3, myString4);