FormatCurrency (Función, Visual Basic)

Artículo
10/07/2008

Actualización: noviembre 2007

Devuelve una expresión con formato de moneda en la que se utilizará el símbolo de moneda que se haya definido en el panel de control del sistema.

Function FormatCurrency(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

Parámetros

Expression
Requerido. Expresión a la que se va a dar formato.
NumDigitsAfterDecimal
Opcional. Valor numérico que indica cuántos lugares a la derecha del signo decimal se van a mostrar. El valor predeterminado es –1, que indica que se utilizará la configuración regional del equipo.
IncludeLeadingDigit
Opcional. Enumeración de triple estado que indica si los valores fraccionarios han de llevar cero inicial o no. Vea la sección "Valores" para conocer los valores utilizados.
UseParensForNegativeNumbers
Opcional. Enumeración de triple estado que indica si los valores negativos han de situarse entre paréntesis o no. Vea la sección "Valores" para conocer los valores utilizados.
GroupDigits
Opcional. Enumeración de triple estado que indica si los números se han de agrupar utilizando el delimitador de grupos especificado en la configuración regional del equipo. Vea la sección "Valores" para conocer los valores utilizados.

Valores

Los argumentos IncludeLeadingDigit, UseParensForNegativeNumbers y GroupDigits toman los siguientes valores de enumeración de triple estado.

Valor	Descripción
TriState.True	True
TriState.False	False
TriState.UseDefault	Configuración regional del equipo

Excepciones

Tipo de excepción	Número de error	Condición
ArgumentException		El número de dígitos situados a continuación del signo decimal es mayor que 99.
InvalidCastException		El tipo no es numérico.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Cada vez que se omita algún argumento opcional, el equipo lo reemplazará por el valor que se ajuste a su configuración regional.

La configuración regional del sistema determinará la posición del símbolo de moneda con respecto al valor moneda.

Nota:
Toda la información de configuración provendrá de la configuración regional de la aplicación. De manera predeterminada, la configuración regional será la establecida en el panel de control. Sin embargo, a excepción del cero inicial, que procede de la ficha Number, la configuración regional podrá cambiarse mediante programación en .NET Framework.

Ejemplo

En el siguiente ejemplo se muestra el uso de la función FormatCurrency.

Dim TestDebt As Double = -4456.43
Dim TestString As String
' Returns "($4,456.43)".
TestString = FormatCurrency(TestDebt, , , TriState.True, TriState.True)