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

FormatDoubleToString

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 a double number using a proper format.

Syntax

void avl::FormatDoubleToString
(
	const atl::real64& inDouble,
	const int inIntegerDigitCount,
	const int inFractionalDigitCount,
	const atl::String& inDecimalMark,
	const atl::String& inTrailingCharacter,
	const bool inForceSignPrinting,
	const atl::String& inSuffix,
	atl::String& outString
)

Parameters

	Name	Type	Range	Default	Description
	inDouble	const real64&			Input real
	inIntegerDigitCount	const int	0 - 1000		How many characters the integer part of the input real should have at least
	inFractionalDigitCount	const int	0 - 100	3	How many characters the fractional part of the input real should have
	inDecimalMark	const String&		\".\"	The symbol used to separate the integer part from the fractional part of the number
	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)
	outString	String&			Output string

Errors