Matrix.IFormat(String, String) Method

Top

Description

Converts the integer values contained within the calling Matrix into a string based on the format specifiers given by formatString. If values in the calling Matrix are not integers, only the integer parts of the values will be used. Matrix columns will be delimited using columnDelimiter, and rows will be delimited with a newline.

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.IFormat(	String formatString,
	String columnDelimiter)

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.

Return Value

Type:

string

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

Syntax

myString1 = myMatrix1.IFormat(myString2, myString3);