GetCurrencyFormatA-Funktion (winnls.h)
Formatiert eine Zahlenzeichenfolge als Währungszeichenfolge für ein durch den Bezeichner angegebenes Gebietsschema.
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
Gebietsschemabezeichner , der 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.
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwFlags
Flags, die das Währungsformat steuern. 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.
[in] lpValue
Ausführliche Informationen finden Sie im lpValue-Parameter von GetCurrencyFormatEx.
[in, optional] lpFormat
Zeiger auf eine CURRENCYFMT-Struktur , die Währungsformatinformationen 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 verwenden soll. 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 negative Vorzeichen, das vom Gebietsschema verwendet wird.
[out, optional] lpCurrencyStr
Zeiger auf einen Puffer, in dem diese Funktion die formatierte Währungszeichenfolge abruft.
[in] cchCurrency
Größe des puffers lpCurrencyStr 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 lpCurrencyStr-Parameter nicht verwendet.
Rückgabewert
Gibt die Anzahl der Im Puffer abgerufenen Zeichen zurück, die von lpCurrencyStr bei erfolgreicher Ausführung angegeben werden. Wenn der cchCurrency-Parameter auf 0 festgelegt ist, gibt die Funktion die Größe des Puffers zurück, der für die formatierte Währungszeichenfolge erforderlich ist, einschließlich eines abschließenden NULL-Zeichens.
Die Funktion gibt 0 zurück, wenn sie nicht erfolgreich ist. Um erweiterte Fehlerinformationen zu erhalten, kann die Anwendung GetLastError aufrufen, wodurch einer 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. Jeder der Parameterwerte war ungültig.
Hinweise
Diese Funktion kann Daten aus benutzerdefinierten Gebietsschemas abrufen. Es ist nicht garantiert, dass die Daten von Computer zu Computer oder zwischen Ausführungen einer Anwendung identisch sind. Wenn Ihre Anwendung Daten beibehalten oder übertragen muss, finden Sie weitere Informationen unter Verwenden persistenter Gebietsschemadaten.
Wenn die ANSI-Version dieser Funktion mit einem reinen Unicode-Gebietsschemabezeichner verwendet wird, kann der Aufruf erfolgreich sein, da das Betriebssystem die Systemcodepage verwendet. Jedoch werden Zeichen, die auf der Systemcodepage nicht definiert sind, in der Zeichenfolge als Fragezeichen (?) angezeigt.
Hinweis
Der winnls.h-Header definiert GetCurrencyFormat als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch 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
| Unterstützte Mindestversion (Client) | Windows 2000 Professional [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | winnls.h (windows.h einschließen) |
| Bibliothek | Kernel32.lib |
| DLL | Kernel32.dll |