Función GetTimeFormatWrapW

[GetTimeFormatWrapW está disponible para su uso en Windows XP. Es posible que no esté disponible en versiones posteriores. Debe usar GetTimeFormatW en su lugar.

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

Nota

GetTimeFormatWrapW es un contenedor para la función GetTimeFormatW . Consulte la página GetTimeFormat para obtener más notas de uso.

 

Sintaxis

int GetTimeFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpTime,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzTimeStr,
  _In_        int        cchTime
);

Parámetros

Configuración regional [in]

Tipo: LCID

Especifica la configuración regional para la que se va a dar formato a la cadena de hora. Si pwzFormat es NULL, la función da formato a la cadena según el formato de hora 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 marcadores de hora 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. Puede especificar una combinación de los valores siguientes.

LOCALE_NOUSEROVERRIDE

Si se establece, la función da formato a la cadena mediante el formato de hora 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 en el formato de hora predeterminado de la configuración regional. Esta marca solo se puede establecer si pwzFormat es NULL.

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 configuración regional.

TIME_NOMINUTESORSECONDS

No usa minutos ni segundos.

TIME_NOSECONDS

No usa segundos.

TIME_NOTIMEMARKER

No usa un marcador de tiempo.

TIME_FORCE24HOURFORMAT

Siempre usa un formato de hora de 24 horas.

lpTime [in]

Tipo: const SYSTEMTIME*

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

pwzFormat [in]

Tipo: LPCWSTR

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

pwzTimeStr [out]

Tipo: LPWSTR

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

cchTime [in]

Tipo: int

Tamaño, en caracteres, del búfer pwzTimeStr . Si cchTime es cero, la función devuelve el número de caracteres necesarios para contener la cadena de tiempo con formato y no se usa el búfer al que apunta pwzTimeStr .

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 pwzTimeStr. Si el parámetro cchTime es cero, el valor devuelto es el número de caracteres necesarios para contener la cadena de tiempo 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

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

Se debe llamar a GetTimeFormatWrapW directamente desde Shlwapi.dll, mediante ordinal 310.

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

GetTimeFormat