Поделиться через

Функция StringCchVPrintf_lW (strsafe.h)

  • Статья

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

StringCchVPrintf_l похож на StringCchVPrintf , но включает параметр для сведений о языковом стандарте.

Синтаксис

STRSAFEAPI StringCchVPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]  _locale_t                                       locale,
  [in]  va_list                                         argList
);

Параметры

[out] pszDest

Буфер назначения, который получает отформатированную строку со значением NULL, созданную из pszFormat и argList.

[in] cchDest

Размер буфера назначения в символах. Это значение должно быть достаточно большим, чтобы вместить окончательную отформатированную строку плюс 1 для учета завершающего символа NULL. Максимально допустимое количество символов — STRSAFE_MAX_CCH.

[in] pszFormat

Строка формата. Эта строка должна заканчиваться null. Дополнительные сведения см. в разделе Синтаксис спецификации формата.

[in] locale

Объект языкового стандарта. Дополнительные сведения см. в разделе _create_locale.

[in] argList

Аргументы, которые необходимо вставить в строку pszFormat .

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

Эта функция может возвращать одно из следующих значений. Настоятельно рекомендуется использовать макросы SUCCEEDED и FAILED для проверки возвращаемого значения этой функции.

Код возврата Описание
S_OK
 Было достаточно места для копирования результата в pszDest без усечения, и буфер завершается null.
STRSAFE_E_INVALID_PARAMETER
 Значение в cchDest равно 0 или больше STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER
 Операция копирования завершилась сбоем из-за нехватки места в буфере. Буфер назначения содержит усеченную версию предполагаемого результата, завершаемую null. В ситуациях, когда усечение является приемлемым, это не обязательно может рассматриваться как условие сбоя.

Комментарии

Дополнительные сведения о va_lists см. в соглашениях, определенных в Stdarg.h.

Поведение не определено, если строки, на которые указывают pszDest, pszFormat или любые строки аргументов, перекрываются.

Ни pszFormat , ни pszDest не должны иметь значение NULL. Если требуется обработка значений строкового указателя NULL, см. раздел StringCchVPrintf_lEx .

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

#define STRSAFE_LOCALE_FUNCTIONS

Примечание

Заголовок strsafe.h определяет StringCchVPrintf_l как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования

   
Минимальная версия клиента Windows Vista [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2008 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header strsafe.h