Função StringCchCatExA (strsafe.h)
Concatena 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.
StringCchCatEx adiciona à funcionalidade de StringCchCat retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de caracteres deixados não utilizados nessa cadeia de caracteres. Os sinalizadores também podem ser passados para a função para controle adicional.
StringCchCatEx é uma substituição para as seguintes funções:
Sintaxe
STRSAFEAPI StringCchCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszSrc,
[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 para pszSrc, e que 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 as cadeias de caracteres e 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 que deve ser concatenada até o final do pszDest. Essa cadeia de caracteres deve ser terminada em nulo.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
O endereço de um ponteiro para o final do pszDest. Se ppszDestEnd não for NULL e qualquer dado for acrescentado 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 | Significado |
|---|---|
|
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 caractere nulo de terminação. |
|
Trate ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT("")). Esse sinalizador é útil para emular funções como lstrcpy. |
|
Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer 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. |
|
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. |
|
Se a função falhar, pszDest será intocado. Nada é adicionado ao conteúdo original. |
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 |
|---|---|
|
Os dados de origem estavam presentes, as cadeias de caracteres eram totalmente concatenadas sem truncamento e o buffer de destino resultante é encerrado em nulo. |
|
O valor em cchDest é 0 ou maior que STRSAFE_MAX_CCH ou o buffer de destino já está cheio. |
|
A operação de cópia falhou devido a 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 , ao contrário das funções que ela substitui.
Comentários
StringCchCatEx 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. StringCchCatEx 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, embora os valores NULL sejam ignorados.
StringCchCatEx 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, conforme mostrado na tabela a seguir.
| Tipo de dados da cadeia de caracteres | Literal da cadeia de caracteres | Função |
|---|---|---|
| char | “cadeia de caracteres” | StringCchCatExA |
| TCHAR | TEXT("string") | StringCchCatEx |
| WCHAR | L"string" | StringCchCatExW |
Observação
O cabeçalho strsafe.h define StringCchCatEx 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