Функция GetTimeFormatWrapW

[GetTimeFormatWrapW доступен для использования в Windows XP. Он может быть недоступен в последующих версиях. Вместо нее следует использовать GetTimeFormatW .]

Форматирует время в виде строки времени для указанного языкового стандарта. Функция форматирует заданное время или локальное системное время.

Примечание

GetTimeFormatWrapW — это оболочка для функции GetTimeFormatW . Дополнительные заметки об использовании см. на странице GetTimeFormat .

 

Синтаксис

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

Параметры

Языковой стандарт [in]

Тип: LCID

Указывает языковой стандарт, для которого должна быть отформатирована строка времени. Если pwzFormat имеет значение NULL, функция форматирует строку в соответствии с форматом времени для этого языкового стандарта. Если pwzFormat не имеет значение NULL, функция использует языковой стандарт только для сведений, не указанных в строке рисунка формата (например, меток времени языкового стандарта).

Этот параметр может быть идентификатором языкового стандарта, созданным макросом MAKELCID , или одним из следующих предопределенных значений.

LOCALE_SYSTEM_DEFAULT

Языковой стандарт системы по умолчанию.

LOCALE_USER_DEFAULT

Языковой стандарт пользователя по умолчанию.

dwFlags [in]

Тип: DWORD

Задает различные параметры функции. Можно указать сочетание следующих значений.

LOCALE_NOUSEROVERRIDE

Если задано значение , функция форматирует строку, используя системный формат времени по умолчанию для указанного языкового стандарта. Если значение не задано, функция форматирует строку, используя любой пользователь, переопределяет формат времени по умолчанию языкового стандарта. Этот флаг можно установить, только если pwzFormat имеет значение NULL.

LOCALE_USE_CP_ACP

Использует системную кодовую страницу ANSI для перевода строк вместо кодовой страницы языкового стандарта.

TIME_NOMINUTESORSECONDS

Не использует минуты или секунды.

TIME_NOSECONDS

Не использует секунды.

TIME_NOTIMEMARKER

Не использует метку времени.

TIME_FORCE24HOURFORMAT

Всегда используется 24-часовой формат времени.

lpTime [in]

Тип: const SYSTEMTIME*

Указатель на структуру SYSTEMTIME , содержащую отформатированные сведения о времени. Если этот указатель имеет значение NULL, функция использует текущее локальное системное время.

pwzFormat [in]

Тип: LPCWSTR

Указатель на формат, используемый для формирования строки времени. Если pwzFormat имеет значение NULL, функция использует формат времени указанного языкового стандарта. Дополнительные сведения см. в разделе GetTimeFormat .

pwzTimeStr [out]

Тип: LPWSTR

Указатель на буфер, получающий отформатированную строку времени.

cchTime [in]

Тип: int

Размер буфера pwzTimeStr (в символах). Если cchTime равно нулю, функция возвращает количество символов, необходимое для хранения отформатируемой строки времени, а буфер, на который указывает pwzTimeStr , не используется.

Возвращаемое значение

Тип: int

Если функция выполнена успешно, возвращаемое значение — это количество символов, записанных в буфер, на который указывает pwzTimeStr. Если параметр cchTime равен нулю, возвращаемое значение — это количество символов, необходимое для хранения форматируемой строки времени. Число включает в себя завершающий символ NULL.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError. GetLastError может возвращать один из следующих кодов ошибок.

ERROR_INSUFFICIENT_BUFFER

ERROR_INVALID_FLAGS

ERROR_INVALID_PARAMETER

Комментарии

GetTimeFormatWrapW предоставляет возможность использовать строки Юникода в операционных системах более ранних версий, чем Windows XP. Предпочтительный метод — использовать GetTimeFormatW в сочетании с Microsoft Layer для Юникода (MSLU).

Метод GetTimeFormatWrapW должен вызываться непосредственно из Shlwapi.dll, используя порядковый номер 310.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
DLL	Shlwapi.dll (версия 5.0 или более поздняя)

См. также раздел

GetTimeFormat