Функция SHFormatDateTimeA (shlwapi.h)
[SHFormatDateTime доступен для использования в операционных системах, указанных в разделе Требования. Он может быть изменен или недоступен в последующих версиях.]
Создает строковое представление времени, указанного в виде структуры FILETIME .
Синтаксис
int SHFormatDateTimeA(
[in] const FILETIME *pft,
[in, out, optional] DWORD *pdwFlags,
[out] LPSTR pszBuf,
UINT cchBuf
);
Параметры
[in] pft
Тип: const FILETIME UNALIGNED*
Указатель на структуру FILETIME , время которой должно быть преобразовано в строку.
[in, out, optional] pdwFlags
Тип: DWORD*
Указатель на значение DWORD , содержащее побитовые флаги, указывающие формат даты и времени.
При вызове функции можно объединить ноль или несколько следующих флагов с исключениями, как указано. Для этого параметра также можно задать значение NULL. В этом случае функция предполагает, что установлен флаг FDTF_DEFAULT.
FDTF_SHORTTIME (0x00000001)
0x00000001. Форматирует время суток в соответствии с приложением "Региональные и языковые параметры" в панель управления, но без секунд. Этот флаг нельзя сочетать с FDTF_LONGTIME.
Короткое время было успешно отформатировано.
FDTF_SHORTDATE (0x00000002)
0x00000002. Форматирует дату в соответствии с коротким форматом даты в приложении "Региональные и языковые параметры" в панель управления. Этот флаг нельзя сочетать с FDTF_LONGDATE.
Короткая дата успешно отформатирована.
FDTF_DEFAULT
Эквивалент FDTF_SHORTDATE | FDTF_SHORTTIME.
FDTF_LONGDATE (0x00000004)
0x00000004. Форматирует дату в формате длинной даты в приложении "Региональные и языковые параметры" в панель управления. Этот флаг нельзя сочетать с FDTF_SHORTDATE.
Длинная дата успешно отформатирована.
FDTF_LONGTIME (0x00000008)
0x00000008. Форматирует время суток в соответствии с приложением "Региональные и языковые параметры" в панель управления, включая секунды. Этот флаг нельзя сочетать с FDTF_SHORTTIME.
Долгое время было успешно отформатировано.
FDTF_RELATIVE (0x00000010)
0x00000010. Если установлен флаг FDTF_LONGDATE и дата в структуре FILETIME совпадает с датой вызова SHFormatDateTime , то день недели (при наличии) изменяется на "Сегодня". Если датой в структуре является предыдущий день, то день недели (если он имеется) изменяется на "Вчера".
Для даты использовалась относительная нотация.
FDTF_LTRDATE (0x00000100)
0x00000100. Добавляет метки для макета чтения слева направо. Этот флаг нельзя сочетать с FDTF_RTLDATE.
FDTF_RTLDATE (0x00000200)
0x00000200. Добавляет метки для макета чтения справа налево. Этот флаг нельзя сочетать с FDTF_LTRDATE.
FDTF_NOAUTOREADINGORDER (0x00000400)
0x00000400. Метки порядка чтения не вставляются. Обычно при отсутствии флага FDTF_LTRDATE или FDTF_RTLDATE SHFormatDateTime определяет порядок чтения из языкового стандарта пользователя по умолчанию, вставляет метки порядка чтения и соответствующим образом обновляет выходное значение pdwFlags . Этот флаг предотвращает выполнение этого процесса. Чаще всего он используется устаревшими вызывающими абонентами SHFormatDateTime. Этот флаг нельзя сочетать с FDTF_RTLDATE или FDTF_LTRDATE.
Windows Server 2003 и Windows XP: Это значение недоступно.
При возврате функции значение DWORD , на которое указывает этот параметр, может содержать ноль или более следующих флагов.
[out] pszBuf
Тип: LPTSTR
Указатель на буфер, который получает форматированные дату и время. Буфер должен быть достаточно большим, чтобы содержать количество символов TCHAR, указанное параметром cchBuf , включая завершающий символ NULL.
cchBuf
Тип: UINT
Количество TCHAR, которые могут содержаться буфером, на который указывает pszBuf.
Возвращаемое значение
Тип: int
Возвращает число TCHAR, записанных в буфер, включая завершающий символ NULL. При сбое это значение равно 0.
Комментарии
Примечание
Заголовок shlwapi.h определяет SHFormatDateTime как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows XP [только классические приложения] |
| Минимальная версия сервера | Windows Server 2003 [только классические приложения] |
| Целевая платформа | Windows |
| Header | shlwapi.h |
| Библиотека | Shlwapi.lib |
| DLL | Shlwapi.dll (версия 5.0 или более поздняя) |