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

Статья
02/07/2025

Функция RtlUnalignedStringCchLengthW — это версия функции RtlStringCchLength, которая принимает неуправляемый указатель на строку символов Юникода.

Синтаксис

NTSTRSAFEDDI RtlUnalignedStringCchLengthW(
  [in]            STRSAFE_PCUNZWCH psz,
  [in]            size_t           cchMax,
  [out, optional] size_t           *pcchLength
);

Параметры

[in] psz

Предоставляет указатель на буфер, содержащий строку, завершающую значение NULL, длина которой RtlUnalignedStringCchLengthW будет проверяться.

[in] cchMax

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

[out, optional] pcchLength

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

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

RtlUnalignedStringCchLengthW возвращает одно из следующих значений NTSTATUS.

Возвращаемый код	Описание
STATUS_SUCCESS	Это состояние успешного означает строку, что параметр psz не был NULL, а длина строки (включая символ NULL) меньше или равно символам cchMax.
STATUS_INVALID_PARAMETER	Это состояние означает, что значение psz равно NULL, cchMax больше NTSTRSAFE_MAX_CCH или psz больше cchMax.

Сведения об тестировании значений NTSTATUS см. в использование значений NTSTATUS.

Замечания

Функция RtlUnalignedStringCchLengthW доступна для архитектур процессоров, таких как На основе Itanium и x64, которые вызывают исключения выравнивания при попытке программного обеспечения получить доступ к неуправляемым данным. На этих процессорах можно использовать RtlUnalignedStringCchLengthW вместо RtlStringCchLength, чтобы избежать исключений выравнивания. (Для процессоров, не вызывающих исключений выравнивания, RtlUnalignedStringCchLengthW эквивалентно RtlStringCchLength.)

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

Требования

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

См. также

RtlStringCchLength

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