Função StringCchCopyNExW (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 após o 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. Sinalizadores também podem ser passados para a função para controle adicional.
StringCchCopyNEx é uma substituição para as seguintes funções:
Sintaxe
STRSAFEAPI StringCchCopyNExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_PCNZWCH pszSrc,
[in] size_t cchToCopy,
[out, optional] STRSAFE_LPWSTR *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 de 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 permitido é STRSAFE_MAX_CCH.
[in] pszSrc
Tipo: LPCTSTR
A cadeia de caracteres de origem. Essa cadeia de caracteres deve ser legível até cchSrc caracteres ou um terminador nulo, o que ocorrer 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 até o final de 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 encerramento no final da cadeia de caracteres.
[out, optional] pcchRemaining
Tipo: size_t*
O número de caracteres não utilizados em 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 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, 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. |
|
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
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 sobrecargas de buffer. StringCchCopyNEx 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.
Embora essa rotina seja destinada como uma substituição para strncpy, há diferenças no comportamento. Se cchSrc for maior que o número de caracteres em pszSrc, StringCchCopyNEx— ao contrário strncpy — não continuará a pszDest com caracteres nulos até que caracteres cchSrc tenham sido copiados.
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.
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 de cadeia de caracteres | Literal de cadeia de caracteres | Função |
|---|---|---|
| char | "string" | stringCchCopyNExA |
| TCHAR | TEXT("string") | stringCchCopyNEx |
| WCHAR | L"string" | stringCchCopyNExW |
Nota
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. 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