Retorna uma expressão formatada como um valor de moeda usando o símbolo de moeda definido no painel de controle do sistema.
Sintaxe
FormatCurrency(Expression [, NumDigitsAfterDecimal ] [, IncludeLeadingDigit ] [, UseParensForNegativeNumbers ] [, GroupDigits ] )
A sintaxe da função FormatCurrency tem os seguintes argumentos:
| Argumento | Descrição |
|---|---|
| Expressão | Obrigatório. Expressão a ser formatada. |
| NumDigitsAfterDecimal | Opcional. Valor numérico indicando quantas casas à direita do decimal são exibidas. O valor padrão é –1, que indica que as configurações regionais do computador são usadas. |
| IncludeLeadingDigit | Opcional. Constante de três estados que indica se um zero à esquerda é exibido ou não para valores fracionários. Consulte a seção Configurações para obter os valores. |
| UseParensForNegativeNumbers | Opcional. Constante tristate que indica se os valores negativos devem ou não ser colocados entre parênteses. Consulte a seção Configurações para obter os valores. |
| GroupDigits | Opcional. Constante de três estados que indica se os números estão agrupados ou não usando o delimitador de grupo especificado nas configurações regionais do computador. Consulte a seção Configurações para obter os valores. |
Configurações
Os argumentos IncludeLeadingDigit, UseParensForNegativeNumbers e GroupDigits têm as seguintes configurações:
| Constante | Valor | Descrição |
|---|---|---|
| vbTrue | –1 | Verdadeira |
| vbFalse | 0 | Falsa |
| vbUseDefault | –2 | Use a configuração das configurações regionais do computador. |
Comentários
Quando um ou mais argumentos opcionais são omitidos, os valores dos argumentos omitidos são fornecidos pelas configurações regionais do computador.
A posição do símbolo da moeda em relação ao valor da moeda é determinada pelas configurações regionais do sistema.
Observação
Todas as informações de configurações vêm da guia Conversor de Moedas das Configurações Regionais, exceto o zero à esquerda, que vem da guia Número.
Exemplos
| Expressão. | Resultados |
|---|---|
| SELECT FormatCurrency([UnitPrice]) AS Expr1 FROM ProductSales; | Formata os valores numéricos no campo "PreçoUnitário" no formato "Conversor de Moedas" e retorna na coluna Expr1. |
| SELECT Formatcurrency([Discount],2,-1,-1,-1) AS DiscountedPrice FROM ProductSales; | Formata os valores numéricos no campo "Desconto" no formato "Conversor de Moedas" com 2 casas decimais, todos os valores inferiores a 1 terão "0" antes da casa decimal, os valores negativos serão cobertos entre parênteses, o valor será agrupado por delimitador padrão ("1000" será exibido como R$ 1.000,00, "-1000" será exibido como (R$ 1.000,00), "0" será exibido como R$ 0,00). |