Função StringCchCatNA (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 após o final desse buffer.
StringCchCatN é uma substituição para as seguintes funções:
Sintaxe
STRSAFEAPI StringCchCatNA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToAppend
);
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, até caracteres cchMaxAppend, é 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 ou cchMaxAppend (o que for menor). A essa soma, adicione 1 para considerar o caractere nulo de encerramento. O número máximo de caracteres permitido é STRSAFE_MAX_CCH.
[in] pszSrc
Tipo: LPCTSTR
A cadeia de caracteres de origem concatenada ao final de 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 a pszDest.
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 |
|---|---|
|
Os dados de origem estavam presentes, as cadeias de caracteres foram concatenadas sem truncamento e o buffer de destino resultante foi encerrado em nulo. |
|
O valor em cchDest é maior que STRSAFE_MAX_CCHou o buffer de destino já está cheio. |
|
A operação de concatenação falhou devido ao 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, diferentemente das funções que ela substitui.
Observações
Em comparação com as funções que ele substitui, StringCchCatN 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. StringCchCatN 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. Consulte StringCchCatNEx se você precisar lidar com valores nulos de ponteiro de cadeia de caracteres.
stringCchCatN 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" | stringCchCatNA |
| TCHAR | TEXT("string") | stringCchCatN |
| WCHAR | L"string" | stringCchCatNW |
Nota
O cabeçalho strsafe.h define StringCchCatN 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
de referência de
stringCchCatNEx