Función GetCalendarDateFormatEx

  • Artículo

En desuso. Recupera una cadena de fecha con formato correcto para la configuración regional especificada mediante la fecha y el calendario especificados. El usuario puede especificar el formato de fecha corta, el formato de fecha larga, el formato de mes de año o un patrón de formato personalizado.

Nota

Esta función puede recuperar datos que cambian entre versiones, por ejemplo, debido a una configuración regional personalizada. Si la aplicación debe conservar o transmitir datos, consulte Uso de datos de configuración regional persistente.

 

Sintaxis

BOOL GetCalendarDateFormatEx(
  _In_        LPCWSTR       lpszLocale,
  _In_        DWORD         dwFlags,
  _In_  const LPCALDATETIME lpCalDateTime,
  _In_        LPCWSTR       lpFormat,
  _Out_       LPWSTR        lpDateStr,
  _In_        int           cchDate
);

Parámetros

lpszLocale [in]

Puntero a un nombre de configuración regional o uno de los siguientes valores predefinidos.

dwFlags [in]

Marcas que especifican opciones de formato de fecha. Si lpFormat no está establecido en NULL, este parámetro debe establecerse en 0. Si lpFormat se establece en NULL, la aplicación puede especificar una combinación de los siguientes valores y LOCALE_NOUSEROVERRIDE.

Valor Significado
DATE_SHORTDATE
 Use el formato de fecha corta. Este es el valor predeterminado. Este valor no se puede usar con DATE_LONGDATE o DATE_YEARMONTH.
DATE_LONGDATE
 Use el formato de fecha larga. Este valor no se puede usar con DATE_SHORTDATE o DATE_YEARMONTH.
DATE_YEARMONTH
 Use el formato año/mes. Este valor no se puede usar con DATE_SHORTDATE o DATE_LONGDATE.
DATE_LTRREADING
 Agregue marcas para el diseño de lectura de izquierda a derecha. Este valor no se puede usar con DATE_RTLREADING.
DATE_RTLREADING
 Agregue marcas para el diseño de lectura de derecha a izquierda. Este valor no se puede usar con DATE_LTRREADING

 

lpCalDateTime [in]

Puntero a una estructura CALDATETIME que contiene la información de fecha y calendario que se va a dar formato.

lpFormat [in]

Puntero a una cadena de imagen de formato que se usa para formar la cadena de fecha. Los valores posibles para la cadena de imagen de formato se definen en Imágenes de formato Day, Month, Year y Era.

La cadena de imagen de formato debe terminar en null. La función usa la configuración regional solo para la información no especificada en la cadena de imagen de formato, por ejemplo, los nombres de día y mes de la configuración regional. La aplicación establece este parámetro en NULL si la función va a usar el formato de fecha de la configuración regional especificada.

lpDateStr [out]

Puntero a un búfer en el que esta función recibe la cadena de fecha con formato.

cchDate [in]

Tamaño, en caracteres, del búfer lpDateStr . Como alternativa, la aplicación puede establecer este parámetro en 0. En este caso, la función devuelve el número de caracteres necesarios para contener la cadena de fecha con formato y no se usa el parámetro lpDateStr .

Valor devuelto

Devuelve el número de caracteres escritos en el búfer lpDateStr si se ejecuta correctamente. Si el parámetro cchDate se establece en 0, la función devuelve el número de caracteres necesarios para contener la cadena de fecha con formato, incluido el carácter nulo de terminación.

Esta 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_DATE_OUT_OF_RANGE. La fecha especificada estaba fuera del intervalo.
  • 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

La fecha más antigua admitida por esta función es el 1 de enero de 1601.

Esta función no tiene un archivo de encabezado o archivo de biblioteca asociado. La aplicación puede llamar a LoadLibrary con el nombre dll (Kernel32.dll) para obtener un identificador de módulo. A continuación, puede llamar a GetProcAddress con ese identificador de módulo y el nombre de esta función para obtener la dirección de la función.

Requisitos

Requisito Value
Cliente mínimo compatible
 Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible
 Windows Server 2008 [solo aplicaciones de escritorio]
Archivo DLL
Kernel32.dll

Vea también

Compatibilidad con idiomas nacionales

Funciones de compatibilidad con idiomas nacionales

Imágenes con formato día, mes, año y era

NLS: ejemplo de API basadas en nombres

EnumDateFormatsExEx

GetDateFormat

GetDateFormatEx

CALDATETIME