Scale

Gets the scale of the specified currency. This function can be used in these types of rules:

  • Calculation

  • Translation

  • Consolidation

  • Allocation

Syntax

HS.Currency.Scale("Currency")
HS.Currency.Scale(Val1)

Table 11-43 Syntax for Scale Function

Parameter Description

Currency

Name of a valid currency.

Var1

A VisualBasic variable.

Return Value

A number indicating the scale of the specified currency (0 to 9). Specifies the unit in which amounts are displayed and stored for the currency by identifying where the decimal point is placed. The return values are as follows:

  • 0 = Units

  • 1 = Tens

  • 2 = Hundreds

  • 3 = Thousands

  • 4 = Ten Thousands

  • 5 = Hundred Thousands

  • 6 = Millions

  • 7 = Ten Millions

  • 8 = Hundred Millions

  • 9 = Billions

Example

In this example, if the scale for French francs (FF) is 3, then statements between the If...Then and End If statements are executed:

If HS.Currency.Scale("FF") = 3 Then
  ...
End If