C++ Syntax

bool

MKI_ConvertWidthStringEx(

LPWSTR f_pszText,

double f_dValue,

__int32 f_nTotalLen,

__int32 f_nFractionLen,

LPWSTR f_pszUnit );

Converts a width value (based on the currently active line 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.

TotalLen

[__int32] Maximum length of the converted string in characters.

FractionLen

[__int32] Maximum number of fractional digits. Allowed values are 0 to 15. Whether trailing zeros are displayed or not depends on the application's settings.

Unit

[LPWSTR] Text buffer to receive the currently active line 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).