Función GetDateFormatWrapW

[GetDateFormatWrapW está disponible para su uso en Windows XP. No estará disponible en versiones posteriores. Debe usar GetDateFormatW en su lugar.

Da formato a una fecha como una cadena de fecha para una configuración regional especificada. La función da formato a una fecha especificada o a la fecha del sistema local.

Nota

GetDateFormatWrapW es un contenedor para la función GetDateFormatW . Consulte la página GetDateFormat para obtener más notas de uso.

 

Sintaxis

int GetDateFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpDate,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzDateStr,
  _In_        int        cchDate
);

Parámetros

Configuración regional [in]

Tipo: LCID

Configuración regional para la que se va a dar formato a la cadena de fecha. Si pwzFormat es NULL, la función da formato a la cadena según el formato de fecha de esta configuración regional. Si pwzFormat no es 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).

Este parámetro puede ser un identificador de configuración regional creado por la macro MAKELCID o uno de los siguientes valores predefinidos.

LOCALE_SYSTEM_DEFAULT

Configuración regional predeterminada del sistema.

LOCALE_USER_DEFAULT

Configuración regional de usuario predeterminada.

dwFlags [in]

Tipo: DWORD

Especifica varias opciones de función. Si pwzFormat no es NULL, este parámetro debe ser cero. Si pwzFormat es NULL, puede especificar una combinación de los valores siguientes. Si no especifica DATE_YEARMONTH, DATE_SHORTDATE o DATE_LONGDATE, y pwzFormat es NULL, se usa DATE_SHORTDATE como valor predeterminado.

LOCALE_NOUSEROVERRIDE

Si se establece, la función da formato a la cadena mediante el formato de fecha predeterminado del sistema para la configuración regional especificada. Si no se establece, la función da formato a la cadena mediante invalidaciones de usuario al formato de fecha predeterminado de la configuración regional.

LOCALE_USE_CP_ACP

Usa la página de códigos ANSI del sistema para la traducción de cadenas en lugar de la página de códigos de la configuración regional.

DATE_SHORTDATE

Usa el formato de fecha corta. Este valor no se puede usar con DATE_LONGDATE o DATE_YEARMONTH.

DATE_LONGDATE

Usa el formato de fecha larga. Este valor no se puede usar con DATE_SHORTDATE o DATE_YEARMONTH.

DATE_YEARMONTH

Usa el formato de año/mes. Este valor no se puede usar con DATE_SHORTDATE o DATE_LONGDATE.

DATE_USE_ALT_CALENDAR

Usa el calendario alternativo, si existe, para dar formato a la cadena de fecha. Si se establece esta marca, la función usa el formato predeterminado para ese calendario alternativo, en lugar de usar invalidaciones de usuario. Las invalidaciones del usuario solo se usarán en caso de que no haya ningún formato predeterminado para el calendario alternativo especificado.

DATE_LTRREADING

Agrega marcas para el diseño de lectura de izquierda a derecha. Este valor no se puede usar con DATE_RTLREADING.

DATE_RTLREADING

Agrega marcas para el diseño de lectura de derecha a izquierda. Este valor no se puede usar con DATE_LTRREADING.

lpDate [in]

Tipo: const SYSTEMTIME*

Puntero a una estructura SYSTEMTIME que contiene la información de fecha a la que se va a dar formato. Si este puntero es NULL, la función usa la fecha actual del sistema local.

pwzFormat [in]

Tipo: LPCWSTR

Puntero a una imagen de formato que se va a usar para formar la cadena de fecha. Si pwzFormat es NULL, la función usa el formato de fecha de la configuración regional especificada. Consulte GetDateFormat para obtener más detalles.

pwzDateStr [out]

Tipo: LPWSTR

Puntero a un búfer que recibe la cadena de fecha con formato.

cchDate [in]

Tipo: int

Especifica el tamaño, en caracteres, del búfer pwzDateStr . Si cchDate es cero, la función devuelve el número de caracteres necesarios para contener la cadena de fecha con formato y no se usa el búfer al que apunta pwzDateStr .

Valor devuelto

Tipo: int

Si la función se ejecuta correctamente, el valor devuelto es el número de caracteres escritos en el búfer al que apunta pwzDateStr. Si el parámetro cchDate es cero, el valor devuelto es el número de caracteres necesarios para contener la cadena de fecha con formato. El recuento incluye el carácter nulo de terminación.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError. GetLastError puede devolver uno de los siguientes códigos de error.

ERROR_INSUFFICIENT_BUFFER

ERROR_INVALID_FLAGS

ERROR_INVALID_PARAMETER

Comentarios

GetDateFormatWrapW proporciona la capacidad de usar cadenas Unicode en sistemas operativos anteriores a Windows XP. El método preferido es usar GetDateFormatW junto con la capa de Microsoft para Unicode (MSLU).

Se debe llamar a GetDateFormatWrapW directamente desde Shlwapi.dll, con ordinal 311.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Archivo DLL	Shlwapi.dll (versión 5.0 o posterior)

Consulte también

GetDateFormat