Función SHFormatDateTimeA (shlwapi.h)

[SHFormatDateTime está disponible para su uso en los sistemas operativos especificados en la sección Requisitos. Puede modificarse o no estar disponible en versiones posteriores.

Genera una representación de cadena de una hora especificada como una estructura FILETIME .

Sintaxis

int SHFormatDateTimeA(
  [in]                const FILETIME *pft,
  [in, out, optional] DWORD          *pdwFlags,
  [out]               LPSTR          pszBuf,
                      UINT           cchBuf
);

Parámetros

[in] pft

Tipo: const FILETIME UNALIGNED*

Puntero a la estructura FILETIME cuyo tiempo se va a convertir en una cadena.

[in, out, optional] pdwFlags

Tipo: DWORD*

Puntero a un valor DWORD que contiene marcas bit a bit que especifican el formato de fecha y hora.

Al llamar a la función , puede combinar cero o más de las marcas siguientes, con excepciones como se indica. También puede establecer este parámetro en NULL, en cuyo caso la función supone que se establece la marca FDTF_DEFAULT.

FDTF_SHORTTIME (0x00000001)

0x00000001. Da formato a la hora del día según lo especificado por la aplicación Regional y Language Options en Panel de control, pero sin segundos. Esta marca no se puede combinar con FDTF_LONGTIME.

La corta hora se ha formateado correctamente.

FDTF_SHORTDATE (0x00000002)

0x00000002. Da formato a la fecha especificada por el formato de fecha corta en la aplicación Opciones regionales y de idioma en Panel de control. Esta marca no se puede combinar con FDTF_LONGDATE.

La fecha corta se ha formateado correctamente.

FDTF_DEFAULT

Equivalente a FDTF_SHORTDATE | FDTF_SHORTTIME.

FDTF_LONGDATE (0x00000004)

0x00000004. Da formato a la fecha especificada por el formato de fecha larga en la aplicación Opciones regionales y de idioma en Panel de control. Esta marca no se puede combinar con FDTF_SHORTDATE.

La fecha larga se ha formateado correctamente.

FDTF_LONGTIME (0x00000008)

0x00000008. Da formato a la hora del día especificada por la aplicación Regional y Language Options en Panel de control, incluidos los segundos. Esta marca no se puede combinar con FDTF_SHORTTIME.

El largo tiempo se ha formateado correctamente.

FDTF_RELATIVE (0x00000010)

0x00000010. Si se establece la marca FDTF_LONGDATE y la fecha de la estructura FILETIME es la misma fecha a la que se llama a SHFormatDateTime , el día de la semana (si está presente) cambia a "Today". Si la fecha de la estructura es el día anterior, el día de la semana (si está presente) cambia a "Ayer".

La notación relativa se usó para la fecha.

FDTF_LTRDATE (0x00000100)

0x00000100. Agrega marcas para el diseño de lectura de izquierda a derecha. Esta marca no se puede combinar con FDTF_RTLDATE.

FDTF_RTLDATE (0x00000200)

0x00000200. Agrega marcas para el diseño de lectura de derecha a izquierda. Esta marca no se puede combinar con FDTF_LTRDATE.

FDTF_NOAUTOREADINGORDER (0x00000400)

0x00000400. No se insertan marcas de orden de lectura. Normalmente, en ausencia de la marca FDTF_LTRDATE o FDTF_RTLDATE, SHFormatDateTime determina el orden de lectura de la configuración regional predeterminada del usuario, inserta marcas de orden de lectura y actualiza el valor de salida pdwFlags correctamente. Esta marca impide que se produzca ese proceso. Lo usan los autores de llamadas heredados de SHFormatDateTime. Esta marca no se puede combinar con FDTF_RTLDATE o FDTF_LTRDATE.

Windows Server 2003 y Windows XP: Este valor no está disponible.

Cuando se devuelve la función, el valor DWORD al que apunta este parámetro puede contener cero o más de las marcas siguientes.

[out] pszBuf

Tipo: LPTSTR

Puntero a un búfer que recibe la fecha y hora con formato. El búfer debe ser lo suficientemente grande como para contener el número de caracteres TCHAR especificados por el parámetro cchBuf , incluido un carácter nulo de terminación.

cchBuf

Tipo: UINT

Número de TCHAR que puede contener el búfer al que apunta pszBuf.

Valor devuelto

Tipo: int

Devuelve el número de TCHAR escritos en el búfer, incluido el carácter nulo de terminación. En caso de error, este valor es 0.

Comentarios

Nota

El encabezado shlwapi.h define SHFormatDateTime 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

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shlwapi.h
Library Shlwapi.lib
Archivo DLL Shlwapi.dll (versión 5.0 o posterior)

Consulte también

GetDateFormat

GetTimeFormat