Função StringCbCopyNA (strsafe.h)

  • Artigo

Copia o número especificado de bytes 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.

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

Sintaxe

STRSAFEAPI StringCbCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cbToCopy
);

Parâmetros

[out] pszDest

Tipo: LPTSTR

O buffer de destino, que recebe os caracteres copiados.

[in] cbDest

Tipo: size_t

O tamanho do pszDest, em bytes. Esse valor deve ser grande o suficiente para manter os bytes copiados (o tamanho de pszSrc ou o valor de cbSrc, o que for menor) e também considerar o caractere nulo de terminação. O número máximo de caracteres permitido é STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR

A cadeia de caracteres de origem. Essa cadeia de caracteres deve ser terminada em nulo.

[in] cbToCopy

Tipo: size_t

O número máximo de bytes a serem copiados de pszSrc para pszDest.

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
S_OK
 Os dados de origem estavam presentes, os dados foram copiados do pszSrc 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)ou o buffer de destino já está cheio.
STRSAFE_E_INSUFFICIENT_BUFFER
 Falha na operação de cópia devido a 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 , ao contrário das funções que ela substitui.

Comentários

StringCbCopyN 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. StringCbCopyN 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 cbSrc for maior que o número de bytes em pszSrc, StringCbCopyN, ao contrário de strncpy, não continuará a usar pszDest com caracteres nulos até que os bytes cbSrc 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. Consulte StringCbCopyNEx se você precisar da manipulação de valores de ponteiro de cadeia de caracteres nula.

StringCbCopyN 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” StringCbCopyNA
TCHAR TEXT("string") StringCbCopyN
WCHAR L"string" StringCbCopyNW
 

Observação

O cabeçalho strsafe.h define StringCbCopyN 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

StringCbCopy

StringCbCopyNEx

StringCchCopyN