FormatIntegerToString


Creates a string from an integer number using a proper format.

Applications:Useful for preparing a number for display or communication with specific number of digits, sign etc.

Syntax

C++
Python
 
def FormatIntegerToString(
	inInteger: int,
	/,
	*,
	inDigitCount: int = 0,
	inTrailingCharacter: str = "\"0\"",
	inForceSignPrinting: bool = False,
	inSuffix: str = "\"\"",
	inSystemBase: int = 10
)
-> outString: str

Parameters

Name Type Range Default Description
Input value inInteger int Input integer
Input value inDigitCount int 0 - 100 0 How many characters the output string should have at least
Input value inTrailingCharacter str "\"0\"" Defines the trailing character
Input value inForceSignPrinting bool False Forces printing the sign of the number even if the number is positive
Input value inSuffix str "\"\"" Defines a suffix. Generally it is an unit of value (e.g. mm)
Input value inSystemBase int 2 - 16 10 The base of the numeral system
Output value outString str Output string