Skip to content

Number_Default_Mask

See Also: Miscellaneous Functions, Field_Number_Default_Mask, Field Masks

Purpose

Returns a mask for formatting number strings.

Return Type

String

Syntax

Use GlobalFunctionsProcedures.pkg
(Number_Default_Mask( {iDigits}, {iPoints}, {sMask} ))

Where:

  • {iDigits}: The maximum number of digits expected to be formatted by the mask.
  • {iPoints}: The number of decimal points to be formatted by the mask.
  • {sMask}: Must be a valid DataFlex numeric mask.

What It Does

Number_Default_Mask tailors the passed template mask {sMask} to the specified number of digits {iDigits} and decimal points {iPoints}. It returns a DataFlex mask string.

Examples

Use GlobalFunctionsProcedures.pkg

Procedure Example
    String sMask

    Move (
        Number_Default_Mask(
            4, 4, "$,*;($,*)"
        )
    ) to sMask
    Send Info_Box ("Mask = " + sMask) "Example"
End_Procedure

This example displays the mask string "$,###0.0000;($,###0.0000)".