Back to FabImage Library website

You are here: Start » Function Reference » Basic » Format » FormatLocationToString

FormatLocationToString


Header: FIL.h
Namespace: fil
Module: FoundationLite

Converts a location to a string of format "(X, Y)".

Syntax

C++
C#
 
void fil::FormatLocationToString
(
	const fil::Location& inLocation,
	const int inDigitCount,
	const ftl::String& inTrailingCharacter,
	const bool inForceSignPrinting,
	const ftl::String& inSuffix,
	const int inSystemBase,
	const bool inPrintBrackets,
	ftl::String& outString
)

Parameters

Name Type Range Default Description
Input value
 inLocation const Location&
Input value
 inDigitCount const int 0 - How many characters the output coordinate should have at least
Input value
 inTrailingCharacter const String& \"0\" Defines the trailing character
Input value
 inForceSignPrinting const bool False Forces printing the signs of the coordinates even if the number is positive
Input value
 inSuffix const String& \"\" Defines a suffix. Generally it is an unit of value (e.g. mm)
Input value
 inSystemBase const int 2 - 16 10 The base of the numeral system
Input value
 inPrintBrackets const bool True Determines whether the brackets should be printed or not
Output value
 outString String&