Função StringCchCopyNExA (strsafe.h)
Copia o número especificado de caracteres de uma cadeia de caracteres para outra. O tamanho do buffer de destino é fornecido à função para garantir que ele não escreva além do final desse buffer.
StringCchCopyNEx adiciona à funcionalidade de StringCchCopyN 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.
StringCchCopyNEx é uma substituição para as seguintes funções:
Sintaxe
STRSAFEAPI StringCchCopyNExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZCH pszSrc,
[in] size_t cchToCopy,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parâmetros
[out] pszDest
Tipo: LPTSTR
O buffer de destino, que recebe a cadeia de caracteres copiada.
[in] cchDest
Tipo: size_t
O tamanho do pszDest, em caracteres. Esse valor deve ser pelo menos grande o suficiente para manter os caracteres copiados (o comprimento de pszSrc ou o valor de cchSrc, o que for menor) 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. Essa cadeia de caracteres deve ser legível até caracteres cchSrc ou um terminador nulo, o que vier primeiro.
[in] cchToCopy
Tipo: size_t
O número máximo de caracteres a serem copiados de pszSrc para 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 copiados para o 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.
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, totalmente copiados sem truncamento e o buffer de destino resultante foi encerrado em nulo. |
|
PszDest ou pszSrc é maior que STRSAFE_MAX_CCH, pszDest é NULL quando há dados de origem presentes para copiar ou um sinalizador inválido foi passado. |
|
Falha na operação de cópia 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
StringCchCopyNEx 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. StringCchCopyNEx 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.
Embora essa rotina seja destinada como uma substituição para strncpy, há diferenças de comportamento. Se cchSrc for maior que o número de caracteres em pszSrc, StringCchCopyNEx, ao contrário de strncpy, não continuará a usar pszDest com caracteres nulos até que os caracteres cchSrc sejam copiados.
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.
StringCchCopyNEx 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” | StringCchCopyNExA |
| TCHAR | TEXT("string") | StringCchCopyNEx |
| WCHAR | L"string" | StringCchCopyNExW |
Observação
O cabeçalho strsafe.h define StringCchCopyNEx 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