Função StringCbLengthA (strsafe.h)

Artigo
11/20/2024

Determina se uma cadeia de caracteres excede o comprimento especificado, em bytes.

StringCbLength é uma substituição para as seguintes funções:

strlen, wcslen, _tcslen

Sintaxe

STRSAFEAPI StringCbLengthA(
  [in]  STRSAFE_PCNZCH psz,
  [in]  size_t         cbMax,
  [out] size_t         *pcbLength
);

Parâmetros

[in] psz

Tipo: LPCTSTR

A cadeia de caracteres cujo comprimento deve ser verificado.

[in] cbMax

Tipo: size_t

O número máximo de bytes permitidos em psz, incluindo aqueles usados para o caractere nulo de terminação. Esse valor não pode exceder STRSAFE_MAX_CCH * sizeof(TCHAR).

[out] pcbLength

Tipo: size_t*

O número de bytes em psz, excluindo aqueles usados para encerrar o caractere nulo. Esse valor será válido somente se pcb não for NULL e a função for bem-sucedida.

Valor de retorno

Tipo: HRESULT

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use o bem-sucedido e macros de COM FALHA para testar o valor retornado dessa função.

Código de retorno	Descrição
S_OK	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 caracteres cbMax.
STRSAFE_E_INVALID_PARAMETER	O valor em psz é NULL, cbMax é maior que `STRSAFE_MAX_CCH * sizeof(TCHAR)`ou psz é maior que cbMax.

Observe que essa função retorna um valor HRESULT, diferentemente das funções que ela substitui.

Observações

Em comparação com as funções que ele substitui, stringCbLength é uma ferramenta adicional para tratamento de buffer adequado em seu código. A má manipulação de buffer está implicada em muitos problemas de segurança que envolvem sobrecargas de buffer.

StringCbLength pode ser usado em sua forma genérica ou em suas formas mais específicas. O tipo de dados da cadeia de caracteres determina a forma dessa função que você deve usar.

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
char	"string"	StringCbLengthA
TCHAR	TEXT("string")	stringCbLength
WCHAR	L"string"	StringCbLengthW

unalignedStringCbLength é um alias para essa função.

Nota

O cabeçalho strsafe.h define StringCbLength como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows XP com SP2 [aplicativos da área de trabalho \| Aplicativos UWP]
servidor com suporte mínimo	Windows Server 2003 com SP1 [aplicativos da área de trabalho \| Aplicativos UWP]
da Plataforma de Destino	Windows
cabeçalho	strsafe.h

Consulte também

StringCchLength

Compartilhar via