Função StringCbCatNExA (strsafe.h)

Concatena o número especificado de bytes 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 após o final desse buffer.

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

• strncat
• StrNCat

StringCbCatNEx adiciona à funcionalidade de StringCbCatN retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de bytes deixados não utilizados nessa cadeia de caracteres. Sinalizadores também podem ser passados para a função para controle adicional.

Sintaxe

STRSAFEAPI StringCbCatNExA(
  [in, out]       STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cbToAppend,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [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] 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 mais os bytes usados para 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 de pszDest. Essa cadeia de caracteres deve ser terminada em nulo.

[in] cbToAppend

Tipo: size_t

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

[out, optional] ppszDestEnd

Tipo: LPTSTR*

O endereço de um ponteiro até o final de pszDest. Se ppszDestEnd não for NULL e quaisquer dados forem acrescentados ao buffer de destino, isso apontará para o caractere nulo de encerramento no final da cadeia de caracteres.

[out, optional] pcbRemaining

Tipo: size_t*

O número de bytes não utilizados em pszDest, incluindo aqueles usados para o caractere nulo de terminação. Se pcbRemaining for NULL, a contagem não será mantida ou retornada.

[in] dwFlags

Tipo: DWORD

Um ou mais dos valores a seguir.

Valor	Significado
STRSAFE_FILL_BEHIND_NULL 0x00000200	Se a função for bem-sucedida, o byte baixo de dwFlags (0) será usado para preencher a parte não inicializada de pszDest após o término do caractere nulo.
STRSAFE_IGNORE_NULLS 0x00000100	Trate ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT(")).
STRSAFE_FILL_ON_FAILURE 0x00000400	Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer de pszDest e o buffer será encerrado em nulo. No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres pré-existente ou truncada no buffer de destino é substituída.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se a função falhar, pszDest será definido como uma cadeia de caracteres vazia (TEXT(")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres pré-existente ou truncada no buffer de destino é substituída.
STRSAFE_NO_TRUNCATION 0x00001000	Se a função falhar, pszDest não será alterada. Nada é adicionado ao conteúdo original.

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	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 STRSAFE_MAX_CCH * sizeof(TCHAR), um sinalizador inválido foi passado ou há discrepâncias entre o tamanho do pszDest, cbDeste a quantidade de material a ser acrescentada em pszSrc .
STRSAFE_E_INSUFFICIENT_BUFFER	A operação de cópia falhou devido ao espaço em buffer insuficiente. Dependendo do valor de dwFlags, o buffer de destino pode conter 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, diferentemente das funções que ela substitui.

Observações

Em comparação com as funções que ele substitui, StringCbCatNEx 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 sobrecargas de buffer. StringCbCatNEx sempre termina nulo e nunca estouram um buffer de destino válido, mesmo que o conteúdo da cadeia de caracteres de origem mude durante a operação.

O comportamento será indefinido se as cadeias de caracteres apontadas por pszSrc e pszDest sobreposição.

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, embora valores de NULL sejam ignorados.

stringCbCatNEx 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"	StringCbCatNExA
TCHAR	TEXT("string")	StringCbCatNEx
WCHAR	L"string"	StringCbCatNExW

 

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

de referência de

StringCbCatEx

StringCbCatN

stringCchCatNEx