You are here: Start » Function Reference » String » FormatIntegerToString

FormatIntegerToString

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

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

Syntax

void avl::FormatIntegerToString
(
	const int inInteger,
	const int inDigitCount,
	const atl::String& inTrailingCharacter,
	const bool inForceSignPrinting,
	const atl::String& inSuffix,
	const int inSystemBase,
	atl::String& outString
)

Parameters

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

Errors