Función GetCurrencyFormatA (winnls.h)
Da formato a una cadena de número como una cadena de moneda para una configuración regional especificada por el identificador.
Sintaxis
int GetCurrencyFormatA(
[in] LCID Locale,
[in] DWORD dwFlags,
[in] LPCSTR lpValue,
[in, optional] const CURRENCYFMTA *lpFormat,
[out, optional] LPSTR lpCurrencyStr,
[in] int cchCurrency
);
Parámetros
[in] Locale
Identificador de configuración regional que especifica la configuración regional para la que esta función da formato a la cadena de moneda. Puede usar la macro MAKELCID para crear un identificador de configuración regional o usar uno de los siguientes valores predefinidos.
- LOCALE_CUSTOM_DEFAULT
- LOCALE_CUSTOM_UI_DEFAULT
- LOCALE_CUSTOM_UNSPECIFIED
- LOCALE_INVARIANT
- LOCALE_SYSTEM_DEFAULT
- LOCALE_USER_DEFAULT
[in] dwFlags
Marcas que controlan el formato de moneda. La aplicación debe establecer este parámetro en 0 si lpFormat no está establecido en NULL. En este caso, la función da formato a la cadena mediante invalidaciones de usuario al formato de moneda predeterminado para la configuración regional. Si lpFormat se establece en NULL, la aplicación puede especificar LOCALE_NOUSEROVERRIDE para dar formato a la cadena mediante el formato de moneda predeterminado del sistema para la configuración regional especificada.
[in] lpValue
Para obtener más información, consulte el parámetro lpValue de GetCurrencyFormatEx.
[in, optional] lpFormat
Puntero a una estructura CURRENCYFMT que contiene información de formato de moneda. Todos los miembros de la estructura deben contener los valores adecuados. La aplicación puede establecer este parámetro en NULL si la función va a usar el formato de moneda de la configuración regional especificada. Si este parámetro no se establece en NULL, la función usa la configuración regional especificada solo para dar formato a la información no especificada en la estructura CURRENCYFMT , por ejemplo, el valor de cadena para el signo negativo utilizado por la configuración regional.
[out, optional] lpCurrencyStr
Puntero a un búfer en el que esta función recupera la cadena de moneda con formato.
[in] cchCurrency
Tamaño, en caracteres, del búfer lpCurrencyStr . La aplicación establece este parámetro en 0 si la función es devolver el tamaño del búfer necesario para contener la cadena de moneda con formato. En este caso, no se usa el parámetro lpCurrencyStr .
Valor devuelto
Devuelve el número de caracteres recuperados en el búfer indicado por lpCurrencyStr si se ejecuta correctamente. Si el parámetro cchCurrency se establece en 0, la función devuelve el tamaño del búfer necesario para contener la cadena de moneda con formato, incluido un carácter nulo de terminación.
La función devuelve 0 si no se realiza correctamente. Para obtener información de error extendida, la aplicación puede llamar a GetLastError, que puede devolver uno de los siguientes códigos de error:
- ERROR_INSUFFICIENT_BUFFER. Un tamaño de búfer proporcionado no era lo suficientemente grande o se estableció incorrectamente en NULL.
- ERROR_INVALID_FLAGS. Los valores proporcionados para las marcas no eran válidos.
- ERROR_INVALID_PARAMETER. Cualquiera de los valores de parámetro no era válido.
Comentarios
Esta función puede recuperar datos de configuraciones regionales personalizadas. No se garantiza que los datos sean los mismos desde el equipo al equipo o entre ejecuciones de una aplicación. Si la aplicación debe conservar o transmitir datos, consulte Uso de datos de configuración regional persistente.
Cuando la versión ANSI de esta función se usa con un identificador de configuración regional solo Unicode, la llamada puede realizarse correctamente porque el sistema operativo usa la página de códigos del sistema. Sin embargo, los caracteres que no están definidos en la página de códigos del sistema aparecen en la cadena como signo de interrogación (?).
Nota:
El encabezado winnls.h define GetCurrencyFormat como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
| Cliente mínimo compatible | Windows 2000 Professional [solo aplicaciones de escritorio] |
| Servidor mínimo compatible | Windows 2000 Server [solo aplicaciones de escritorio] |
| Plataforma de destino | Windows |
| Encabezado | winnls.h (incluye Windows.h) |
| Library | Kernel32.lib |
| Archivo DLL | Kernel32.dll |