C++ Syntax

bool

MKI_ConvertAreaString(

LPWSTR f_pszText,

const size_t f_unMaxSize1,

double f_dValue,

LPWSTR f_pszUnit,

const size_t f_unMaxSize2 );

template <size_t f_unSize> bool

MKI_ConvertAreaString(

wchar_t (&f_rDestin)[f_unSize],

double f_dValue );

template <size_t f_unSize1, size_t f_unSize2> bool

MKI_ConvertAreaString(

wchar_t (&f_rDestin1)[f_unSize1],

double f_dValue,

wchar_t (&f_rDestin2)[f_unSize2] );

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

Parameters

f_pszText / f_rDestin1

[LPWSTR] Pointer to or [wchar_t[]&] Reference to text buffer to receive the converted double string. If f_pszText is nullptr, the value will not be converted, only the current unit will be returned (see f_pszUnit).

f_unMaxSize1

[const size_t] Maximum allowed length of the destination text in UTF-16 characters including the terminating '\0' character.

f_dValue

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

f_pszUnit / f_rDestin2

[LPWSTR] Pointer to or [wchar_t[]&] Reference to text buffer to receive the currently active length unit in form of a short text (like [mm²]). If f_pszUnit is nullptr, no unit text is returned.

f_unMaxSize2

[const size_t] Maximum allowed length of the unit text in UTF-16 characters including the terminating '\0' character.

Return Value

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

Comment

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