Função StringCbCatNA (strsafe.h)

  • Artigo

Concatena o número especificado de bytes de uma cadeia de caracteres para outra. O tamanho, em bytes, do buffer de destino é fornecido à função para garantir que ele não escreva além do final desse buffer.

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

Sintaxe

STRSAFEAPI StringCbCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cbToAppend
);

Parâmetros

[in, out] pszDest

Tipo: LPTSTR

O buffer de destino, que contém a cadeia de caracteres que deve ser concatenada para pszSrc, e receberá a cadeia de caracteres resultante. A cadeia de caracteres em pszSrc, até cbMaxAppend bytes, é adicionada ao final da cadeia de caracteres em pszDest.

[in] cbDest

Tipo: size_t

O tamanho do buffer de destino, em bytes. Esse valor deve considerar o comprimento de pszSrc mais o comprimento de pszDest ou cbMaxAppend (o que for menor) mais o caractere nulo de terminação. O número máximo de bytes permitidos é STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR

A cadeia de caracteres de origem que deve ser concatenada até o final do pszDest. Essa cadeia de caracteres de origem deve ser terminada em nulo.

[in] cbToAppend

Tipo: size_t

O número máximo de bytes a serem acrescentados ao pszDest.

Retornar valor

Tipo: HRESULT

Essa função pode retornar um dos valores a seguir. É altamente recomendável que você use as macros SUCCEEDED e FAILED para testar o valor retornado dessa função.

Código de retorno Descrição
S_OK
 Os dados de origem estavam presentes, as cadeias de caracteres foram concatenadas sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER
 O valor em cbDest é maior que o valor máximo permitido ou o buffer de destino já está cheio.
STRSAFE_E_INSUFFICIENT_BUFFER
 A operação de concatenação falhou devido a espaço em buffer insuficiente. O buffer de destino contém uma versão truncada e terminada em nulo do resultado pretendido. Em situações em que o truncamento é aceitável, isso pode não ser necessariamente visto como uma condição de falha.
 

Observe que essa função retorna um valor HRESULT , ao contrário das funções que ela substitui.

Comentários

Em comparação com as funções que ele substitui, StringCbCatN fornece processamento 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 estouros de buffer. StringCbCatN sempre termina em nulo e nunca estoura um buffer de destino válido, mesmo que o conteúdo da cadeia de caracteres de origem seja alterado durante a operação.

O comportamento será indefinido se as cadeias de caracteres apontadas por pszSrc e pszDest se sobrepõem.

Nem pszSrc nem pszDest devem ser NULL. Consulte StringCbCatNEx se você precisar da manipulação de valores de ponteiro de cadeia de caracteres nula.

StringCbCatN 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 da cadeia de caracteres Literal da cadeia de caracteres Função
char “cadeia de caracteres” StringCbCatNA
TCHAR TEXT("string") StringCbCatN
WCHAR L"string" StringCbCatNW
 

Observação

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

Requisitos

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

Confira também

Referência

StringCbCat

StringCbCatNEx

StringCchCatN