C++ Syntax

bool

MKI_ConvertAreaString(

LPWSTR f_pszText,

double f_dValue,

LPWSTR f_pszUnit );

Converts an area value (based on the currently active length unit) to a string.

Parameters

Text

[LPWSTR] Text buffer to receive the converted double string. Allow at least MKI_LENGTH_NAME_SHORT characters! If Text is nullptr, the value will not be converted, only the current unit will be returned (see Unit).

Value

[double] Floating point value to be converted into a string.

Unit

[LPWSTR] Text buffer to receive the currently active length unit in form of a short text (like [mm²]). Allow at least MKI_LENGTH_NAME_UNIT characters! If Unit is nullptr, no unit text is returned.

Return Value

Returns true if successful. If false is returned, Text is unchanged.

Comment

This conversion will consider the decimal separator defined by the user (point or comma).