FormatCurrency-Funktion (Visual Basic)

Artikel
09/03/2008

Aktualisiert: November 2007

Gibt einen Ausdruck als Währungsbetrag zurück, der mit dem in der Systemsteuerung festgelegten Währungssymbol formatiert ist.

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

Parameter

Expression
Erforderlich. Zu formatierender Ausdruck.
NumDigitsAfterDecimal
Optional. Numerischer Wert, der angibt, wie viele Stellen rechts vom Dezimaltrennzeichen angezeigt werden. Der Standardwert ist –1, d. h., dass die Ländereinstellungen des Computers verwendet werden.
IncludeLeadingDigit
Optional. TriState-Enumeration, die angibt, ob führende Nullen bei Dezimalzahlen angezeigt werden. Werte finden Sie im Abschnitt "Einstellungen".
UseParensForNegativeNumbers
Optional. TriState-Enumeration, die angibt, ob negative Werte in Klammern gesetzt werden. Werte finden Sie im Abschnitt "Einstellungen".
GroupDigits
Optional. TriState-Enumeration, die angibt, ob Zahlen mithilfe des in den Ländereinstellungen des Computers festgelegten Trennzeichens in Gruppen unterteilt werden. Werte finden Sie im Abschnitt "Einstellungen".

Einstellungen

Für die Argumente IncludeLeadingDigit, UseParensForNegativeNumbers und GroupDigits können die folgenden TriState-Enumerationswerte angegeben werden:

Wert	Beschreibung
TriState.True	True
TriState.False	False
TriState.UseDefault	Die Ländereinstellungen des Computers.

Ausnahmen

Ausnahmetyp	Fehlernummer	Bedingung
ArgumentException	5	Anzahl der Stellen nach dem Dezimalzeichen ist größer als 99.
InvalidCastException	13	Kein numerischer Typ.

Beachten Sie die Spalte "Fehlernummer", wenn Sie Visual Basic 6.0-Anwendungen aktualisieren, die eine unstrukturierte Fehlerbehandlung verwenden. (Sie können die Fehlernummer mit der Number-Eigenschaft (Err-Objekt) vergleichen.) Wenn möglich, sollten Sie jedoch erwägen, eine solche Fehlersteuerung durch eine Übersicht über die strukturierte Ausnahmebehandlung für Visual Basic zu ersetzen.

Hinweise

Wenn ein oder mehrere optionale Argumente nicht angegeben sind, werden die passenden Werte der Ländereinstellungen des Computers verwendet.

Die Position des Währungssymbols im Verhältnis zum Währungswert ergibt sich aus den Ländereinstellungen des Systems.

Hinweis:
Alle Einstellungsinformationen werden vom Gebietsschema der Anwendung übernommen. Standardmäßig handelt es sich hierbei um das in der Systemsteuerung eingestellte Gebietsschema. Mit Ausnahme der vorangestellten 0 (null), die auf der Registerkarte Number festgelegt wird, kann dies mit .NET Framework programmgesteuert geändert werden.

Beispiel

Das folgende Beispiel veranschaulicht die Verwendung der FormatCurrency-Funktion.

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