функция StringCbVPrintf_lW (strsafe.h)

Статья
11/20/2024

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

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

Синтаксис

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

Параметры

[out] pszDest

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

[in] cbDest

Размер целевого буфера в байтах. Это значение должно быть достаточно большим, чтобы вместить последнюю отформатированную строку, а также завершающий символ NULL. Максимально допустимое число байтов — STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszFormat

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

[in] locale

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

[in] argList

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

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

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

Возвращаемый код	Описание
S_OK	Для копирования результата достаточно места для копирования в pszDest без усечения, а буфер завершается значением NULL.
STRSAFE_E_INVALID_PARAMETER	Значение в cbDest равно 0 или больше `STRSAFE_MAX_CCH * sizeof(TCHAR)`.
STRSAFE_E_INSUFFICIENT_BUFFER	Операция копирования завершилась ошибкой из-за нехватки буферного пространства. Целевой буфер содержит усеченную, завершаемую null версию предполагаемого результата. В ситуациях, когда усечение приемлемо, это может не обязательно рассматриваться как условие сбоя.

Замечания

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

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

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

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

#define STRSAFE_LOCALE_FUNCTIONS

Заметка

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

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows Vista [классические приложения \| Приложения UWP]
минимальный поддерживаемый сервер	Windows Server 2008 [классические приложения \| Приложения UWP]
целевая платформа	Виндоус
заголовка	strsafe.h

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