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

Статья
05/03/2024

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

Синтаксис

NTSTRSAFEDDI RtlStringCchPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cchDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcchRemaining,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

Параметры

[out, optional] pszDest

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

[in] cchDest

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

[out, optional] ppszDestEnd

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

[out, optional] pcchRemaining

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

[in] dwFlags

Один или несколько флагов и, при необходимости, байт заполнения. Флаги определяются следующим образом:

Значение	Значение
STRSAFE_FILL_BEHIND_NULL	Если задано и функция выполняется успешно, для заполнения части буфера назначения, следующей за завершающим символом NULL, используется низкий байт dwFlags .
STRSAFE_IGNORE_NULLS	Если задано значение , pszDest , pszSrc или и то, и другое, может иметь значение NULL. Пустые указатели pszSrc обрабатываются как пустые строки (TEXT("")), которые можно скопировать. Указатели NULLpszDest не могут получать непустые строки.
STRSAFE_FILL_ON_FAILURE	Если задано и функция завершается сбоем, для заполнения всего целевого буфера используется низкий байт dwFlags , а буфер завершается значением NULL. Эта операция перезаписывает все уже существующее содержимое буфера.
STRSAFE_NULL_ON_FAILURE	Если задано и функция завершается сбоем, для буфера назначения устанавливается пустая строка (TEXT("")). Эта операция перезаписывает все уже существующее содержимое буфера.
STRSAFE_NO_TRUNCATION	Если задано и функция возвращает STATUS_BUFFER_OVERFLOW, содержимое буфера назначения не изменяется.

[in] pszFormat

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

...

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

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

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

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

Код возврата

Описание

STATUS_SUCCESS

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

STATUS_BUFFER_OVERFLOW

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

STATUS_INVALID_PARAMETER

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

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

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

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

RtlStringCchPrintfExW и RtlStringCchPrintfExA добавляют к функциональным возможностям RtlStringCchPrintf , возвращая указатель на конец конечной строки, а также количество символов, оставшихся неиспользуемыми в этой строке. Флаги можно передать в функцию для дополнительного управления.

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

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

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

Ни pszSrc, ни pszDest не могут иметь значение NULL , если не установлен флаг STRSAFE_IGNORE_NULLS. В этом случае оба значения могут иметь значение NULL. Если pszDest имеет значение NULL, pszSrc должен иметь значение NULL или указывать на пустую строку.

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

Требования

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

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

RtlStringCbPrintfEx

RtlStringCchPrintf

RtlStringCchVPrintfEx