Função StringCchCatNExA (strsafe.h)

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

StringCchCatNEx adiciona à funcionalidade de StringCchCatN retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de caracteres não utilizados nessa cadeia de caracteres. Os sinalizadores também podem ser passados para a função para controle adicional.

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

• strncat
• Strncat

Sintaxe

STRSAFEAPI StringCchCatNExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cchToAppend,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags
);

Parâmetros

[in, out] pszDest

Tipo: LPTSTR

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

[in] cchDest

Tipo: size_t

O tamanho do buffer de destino, em caracteres. Esse valor deve ser igual ao comprimento de pszSrc mais o comprimento de pszDest mais 1 para considerar o caractere nulo de terminação. O número máximo de caracteres permitidos é STRSAFE_MAX_CCH.

[in] pszSrc

Tipo: LPCTSTR

A cadeia de caracteres de origem concatenada ao final do pszDest. Essa cadeia de caracteres deve ser terminada em nulo.

[in] cchToAppend

Tipo: size_t

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

[out, optional] ppszDestEnd

Tipo: LPTSTR*

O endereço de um ponteiro para o final do pszDest. Se ppszDestEnd não for NULL e todos os dados forem anexados ao buffer de destino, isso apontará para o caractere nulo de terminação no final da cadeia de caracteres.

[out, optional] pcchRemaining

Tipo: size_t*

O número de caracteres não utilizados no pszDest, incluindo o caractere nulo de terminação. Se pcchRemaining for NULL, a contagem não será mantida ou retornada.

[in] dwFlags

Tipo: DWORD

Um ou mais dos valores a seguir.

Valor retornado

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.

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, StringCchCatNEx 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. StringCchCatNEx 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 , a menos que o sinalizador STRSAFE_IGNORE_NULLS seja especificado, nesse caso, ambos podem ser NULL. No entanto, um erro devido ao espaço insuficiente ainda pode ser retornado, mesmo que os valores NULL sejam ignorados.

StringCchCatNEx 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.

Requisitos

Confira também

Referência

StringCbCatNEx

StringCchCatEx

StringCchCatN