Функция GetDateFormatWrapW

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

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

Примечание

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

 

Синтаксис

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

Параметры

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

Тип: LCID

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

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

LOCALE_SYSTEM_DEFAULT

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

LOCALE_USER_DEFAULT

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

dwFlags [in]

Тип: DWORD

Задает различные параметры функции. Если pwzFormat не имеет значение NULL, этот параметр должен быть равен нулю. Если pwzFormat имеет значение NULL, можно указать сочетание следующих значений. Если вы не укажете DATE_YEARMONTH, DATE_SHORTDATE или DATE_LONGDATE, а pwzFormat имеет значение NULL, то по умолчанию используется DATE_SHORTDATE.

LOCALE_NOUSEROVERRIDE

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

LOCALE_USE_CP_ACP

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

DATE_SHORTDATE

Использует короткий формат даты. Это значение нельзя использовать с DATE_LONGDATE или DATE_YEARMONTH.

DATE_LONGDATE

Использует формат длинной даты. Это значение нельзя использовать с DATE_SHORTDATE или DATE_YEARMONTH.

DATE_YEARMONTH

Использует формат год/месяц. Это значение нельзя использовать с DATE_SHORTDATE или DATE_LONGDATE.

DATE_USE_ALT_CALENDAR

Использует альтернативный календарь, если он существует, для форматирования строки даты. Если этот флаг установлен, функция использует формат по умолчанию для этого альтернативного календаря, а не какие-либо пользовательские переопределения. Переопределения пользователя будут использоваться только в том случае, если для указанного альтернативного календаря нет формата по умолчанию.

DATE_LTRREADING

Добавляет метки для макета чтения слева направо. Это значение нельзя использовать с DATE_RTLREADING.

DATE_RTLREADING

Добавляет метки для макета чтения справа налево. Это значение нельзя использовать с DATE_LTRREADING.

lpDate [in]

Тип: const SYSTEMTIME*

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

pwzFormat [in]

Тип: LPCWSTR

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

pwzDateStr [out]

Тип: LPWSTR

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

cchDate [in]

Тип: int

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

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

Тип: int

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

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

ERROR_INSUFFICIENT_BUFFER

ERROR_INVALID_FLAGS

ERROR_INVALID_PARAMETER

Комментарии

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

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

Требования

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

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

GetDateFormat