Função RtlStringCchLengthA (ntstrsafe.h)

Artigo
02/07/2025

As funções RtlStringCchLengthW e RtlStringCchLengthA determinam o comprimento, em caracteres, de uma cadeia de caracteres fornecida.

Sintaxe

NTSTRSAFEDDI RtlStringCchLengthA(
  [in] STRSAFE_PCNZCH psz,
  [in] size_t         cchMax,
       size_t         *pcchLength
);

Parâmetros

[in] psz

Um ponteiro para um buffer que contém uma cadeia de caracteres terminada em nulo, do qual o comprimento será verificado.

[in] cchMax

O número máximo de caracteres permitido no buffer apontado por psz, incluindo o caractere nulo de encerramento. Esse valor não pode exceder NTSTRSAFE_MAX_CCH.

pcchLength

Se o chamador fornecer um ponteiro de endereço NULLnão, a função carregará o endereço com o comprimento, em caracteres, da cadeia de caracteres contida no buffer. O comprimento não inclui o caractere nulo de terminação da cadeia de caracteres.

Valor de retorno

A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Código de retorno	Descrição
STATUS_SUCCESS	Esse status de êxito significa que a cadeia de caracteres em psz não foi NULL e o comprimento da cadeia de caracteres (incluindo o caractere nulo de terminação) é menor ou igual a cchMax caracteres.
STATUS_INVALID_PARAMETER	Esse status de erro significa que o valor em psz é NULL, cchMax é maior que NTSTRSAFE_MAX_CCH ou psz é maior que cchMax.

Observações

rtlStringCchLengthW e rtlStringCchLengthA devem ser usados em vez de strlen. Eles são usados para garantir que uma cadeia de caracteres não seja maior do que um determinado comprimento, em caracteres. Se essa condição for atendida, RtlStringCchLengthW e RtlStringCchLengthA retornará o comprimento atual da cadeia de caracteres em caracteres, não incluindo o caractere nulo de terminação.

Use rtlStringCchLengthW para manipular cadeias de caracteres Unicode e rtlStringCchLengthA para lidar com cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir.

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
WCHAR	L"string"	rtlStringCchLengthW
char	"string"	RtlStringCchLengthA

Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	ntstrsafe.h (inclua Ntstrsafe.h)
biblioteca	Ntstrsafe.lib
IRQL	Se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Consulte também

rtlStringCbLength

Partilhar via