Função RtlStringCchLengthA (ntstrsafe.h)

  • Artigo

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, cujo comprimento será verificado.

[in] cchMax

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

pcchLength

Se o chamador fornecer um ponteiro de endereço não NULL , 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.

Retornar valor

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 sucesso status significa que a cadeia de caracteres em psz não era NULL e o comprimento da cadeia de caracteres (incluindo o caractere nulo de terminação) é menor ou igual a caracteres cchMax.
STATUS_INVALID_PARAMETER
 Esse erro status significa que o valor em psz é NULL, cchMax é maior que NTSTRSAFE_MAX_CCH ou psz é maior que cchMax.

Comentários

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 o comprimento atual da cadeia de caracteres em caracteres, sem incluir o caractere nulo de terminação.

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

Tipos de dados de cadeia de caracteres Cadeia de caracteres literal Função
WCHAR L"string" RtlStringCchLengthW
char “cadeia de caracteres” 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
Cliente mínimo com suporte Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho ntstrsafe.h (inclua Ntstrsafe.h)
Biblioteca Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Confira também

RtlStringCbLength