GetCurrencyFormatA-Funktion (winnls.h)

Artikel
11/20/2024

Formatiert eine Zahlenzeichenfolge als Währungszeichenfolge für ein durch bezeichner angegebenes Gebietsschema.

Hinweis Aus Interoperabilitätsgründen sollte die Anwendung die GetCurrencyFormatEx--Funktion vorziehen, um GetCurrencyFormat-, da Microsoft zur Verwendung von Gebietsschemanamen anstelle von Gebietsschemabezeichnern für neue Gebietsschemas migriert wird. Jede Anwendung, die nur unter Windows Vista und höher ausgeführt wird, sollte GetCurrencyFormatExverwenden.

Syntax

int GetCurrencyFormatA(
  [in]            LCID               Locale,
  [in]            DWORD              dwFlags,
  [in]            LPCSTR             lpValue,
  [in, optional]  const CURRENCYFMTA *lpFormat,
  [out, optional] LPSTR              lpCurrencyStr,
  [in]            int                cchCurrency
);

Parameter

[in] Locale

Gebietsschema-ID, das das Gebietsschema angibt, für das diese Funktion die Währungszeichenfolge formatiert. Sie können das MAKELCID Makro verwenden, um einen Gebietsschemabezeichner zu erstellen oder einen der folgenden vordefinierten Werte zu verwenden.

[in] dwFlags

Flags zur Steuerung des Währungsformats. Die Anwendung muss diesen Parameter auf 0 festlegen, wenn lpFormat- nicht auf NULL-festgelegt ist. In diesem Fall formatiert die Funktion die Zeichenfolge mithilfe von Benutzerüberschreibungen in das Standardwährungsformat für das Gebietsschema. Wenn lpFormat- auf NULL-festgelegt ist, kann die Anwendung LOCALE_NOUSEROVERRIDE angeben, um die Zeichenfolge mithilfe des Systemstandardwährungsformats für das angegebene Gebietsschema zu formatieren.

Vorsicht Verwendung von LOCALE_NOUSEROVERRIDE wird dringend davon abgeraten, da die Benutzereinstellungen deaktiviert werden.

[in] lpValue

Ausführliche Informationen finden Sie im lpValue Parameter von GetCurrencyFormatEx.

[in, optional] lpFormat

Zeiger auf eine CURRENCYFMT- Struktur, die Währungsformatierungsinformationen enthält. Alle Member der Struktur müssen geeignete Werte enthalten. Die Anwendung kann diesen Parameter auf NULL- festlegen, wenn die Funktion das Währungsformat des angegebenen Gebietsschemas verwendet. Wenn dieser Parameter nicht auf NULL-festgelegt ist, verwendet die Funktion das angegebene Gebietsschema nur für Formatierungsinformationen, die nicht in der CURRENCYFMT- Struktur angegeben sind, z. B. den Zeichenfolgenwert für das vom Gebietsschema verwendete negative Zeichen.

[out, optional] lpCurrencyStr

Zeiger auf einen Puffer, in dem diese Funktion die formatierte Währungszeichenfolge abruft.

[in] cchCurrency

Größe des lpCurrencyStr Puffers in Zeichen. Die Anwendung legt diesen Parameter auf 0 fest, wenn die Funktion die Größe des Puffers zurückgeben soll, der zum Speichern der formatierten Währungszeichenfolge erforderlich ist. In diesem Fall wird der parameter lpCurrencyStr nicht verwendet.

Rückgabewert

Gibt die Anzahl der im Puffer abgerufenen Zeichen zurück, die durch lpCurrencyStr angegeben werden. Wenn der cchCurrency-Parameter auf 0 festgelegt ist, gibt die Funktion die Größe des Puffers zurück, der zum Speichern der formatierten Währungszeichenfolge erforderlich ist, einschließlich eines endenden Nullzeichens.

Die Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist. Um erweiterte Fehlerinformationen zu erhalten, kann die Anwendung GetLastErroraufrufen, wodurch eine der folgenden Fehlercodes zurückgegeben werden kann:

ERROR_INSUFFICIENT_BUFFER. Eine angegebene Puffergröße war nicht groß genug, oder sie wurde fälschlicherweise auf NULL-festgelegt.
ERROR_INVALID_FLAGS. Die für Flags angegebenen Werte waren ungültig.
ERROR_INVALID_PARAMETER. Ungültige Parameterwerte.

Bemerkungen

Diese Funktion kann Daten aus benutzerdefinierten Gebietsschemasabrufen. Daten sind nicht garantiert identisch von Computer zu Computer oder zwischen Ausführung einer Anwendung. Wenn Ihre Anwendung Daten beibehalten oder übertragen muss, lesen Sie Verwenden persistenter Gebietsschemadaten.

Wenn die ANSI-Version dieser Funktion mit einem Nur-Unicode-Gebietsschemabezeichner verwendet wird, kann der Aufruf erfolgreich ausgeführt werden, da das Betriebssystem die Systemcodepage verwendet. Zeichen, die auf der Systemcodeseite nicht definiert sind, werden jedoch in der Zeichenfolge als Fragezeichen (?) angezeigt.

Anmerkung

Der winnls.h-Header definiert GetCurrencyFormat als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winnls.h (enthalten Windows.h)
Library	Kernel32.lib
DLL-	Kernel32.dll

Siehe auch

Freigeben über