Функция RtlStringCbVPrintfW (ntstrsafe.h)

Статья
08/07/2023

Функции RtlStringCbVPrintfW и RtlStringCbVPrintfA создают текстовую строку с подсчетом байтов с форматированием на основе предоставленных сведений о форматировании.

Синтаксис

NTSTRSAFEDDI RtlStringCbVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

Параметры

[out] pszDest

Указатель на буфер, предоставленный вызывающим объектом, который получает отформатированную строку, завершающуюся значением NULL. Функция создает эту строку на основе строки форматирования, предоставленной pszFormat , и аргументов, предоставленных argList.

[in] cbDest

Размер буфера назначения в байтах. Буфер должен быть достаточно большим, чтобы содержать форматированную строку и завершающий символ NULL.

Для строк Юникода максимальное число байтов равно NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Для строк ANSI максимальное число байтов равно NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszFormat

Указатель на текстовую строку, завершающуюся нулевым значением, которая содержит директивы форматирования в стиле printf.

[in] argList

Список аргументов с va_list типом. Аргументы, содержащиеся в списке аргументов, будут интерпретироваться с помощью строки форматирования, предоставленной pszFormat.

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

Функция возвращает одно из значений NTSTATUS, перечисленных в следующей таблице. Сведения о проверке значений NTSTATUS см. в разделе Использование значений NTSTATUS.

Код возврата	Описание
STATUS_SUCCESS	Это состояние успешного выполнения означает, что исходные данные присутствуют, выходная строка была создана без усечения, а результирующий буфер назначения завершается null.
STATUS_BUFFER_OVERFLOW	Это состояние предупреждения означает, что операция не завершена из-за нехватки места в буфере назначения. Буфер назначения содержит усеченную версию созданной строки.
STATUS_INVALID_PARAMETER	Это состояние ошибки означает, что функция получила недопустимый входной параметр. Дополнительные сведения см. в следующем абзаце. Функция возвращает значение STATUS_INVALID_PARAMETER в следующих случаях: Значение в cbDest больше максимального размера буфера. Буфер назначения уже заполнен. Существовал указатель NULL . Длина буфера назначения равна нулю, но присутствовала строка источника ненулевой длины.

Код возврата

Описание

STATUS_SUCCESS

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

STATUS_BUFFER_OVERFLOW

Это состояние предупреждения означает, что операция не завершена из-за нехватки места в буфере назначения. Буфер назначения содержит усеченную версию созданной строки.

STATUS_INVALID_PARAMETER

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

Функция возвращает значение STATUS_INVALID_PARAMETER в следующих случаях:

Значение в cbDest больше максимального размера буфера.
Буфер назначения уже заполнен.
Существовал указатель NULL .
Длина буфера назначения равна нулю, но присутствовала строка источника ненулевой длины.

Все эти функции принимают строку формата, а также набор аргументов в списке аргументов va_list типа и возвращают форматированную строку. Размер целевого буфера в байтах предоставляется для RtlStringCbVPrintfW и RtlStringCbVPrintfA , чтобы гарантировать, что они не записываются за конец буфера.

Дополнительные сведения о списках аргументов с типом va_list см. в документации по Microsoft Windows SDK.

Используйте RtlStringCbVPrintfW для обработки строк Юникода и RtlStringCbVPrintfA для обработки строк ANSI. Используемая форма зависит от данных, как показано в следующей таблице.

Строковый тип данных	Строковый литерал	Функция
WCHAR	L"string"	RtlStringCbVPrintfW
char	Строка	RtlStringCbVPrintfA

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

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

Дополнительные сведения о функциях безопасных строк см. в разделе Использование безопасных строковых функций.

Требования

Требование	Значение
Минимальная версия клиента	Доступно начиная с Windows XP с пакетом обновления 1 (SP1).
Целевая платформа	Персональный компьютер
Верхняя часть	ntstrsafe.h (включая Ntstrsafe.h)
Библиотека	Ntstrsafe.lib
IRQL	Любой, если строки, которыми осуществляется управление, всегда находятся в памяти, в противном случае PASSIVE_LEVEL

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

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf

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