Função StringCbCopyA (strsafe.h)

  • Artigo

Copia 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.

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

Sintaxe

STRSAFEAPI StringCbCopyA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszSrc
);

Parâmetros

[out] pszDest

Tipo: LPTSTR

O buffer de destino, que recebe a cadeia de caracteres copiada.

[in] cbDest

Tipo: size_t

O tamanho do buffer de destino, em bytes. Esse valor deve considerar o comprimento de pszSrc mais o caractere nulo de terminação. O número máximo de bytes permitidos é STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR

Um ponteiro para um buffer que contém a cadeia de caracteres de origem. Essa cadeia de caracteres de origem deve ser terminada em nulo.

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, totalmente copiados sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STRSAFE_E_INVALID_PARAMETER
 O valor em cbDest é menor sizeof(TCHAR) ou maior que o valor máximo permitido.
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

Em comparação com as funções que ele substitui, StringCbCopy 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. StringCbCopy 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. Consulte StringCbCopyEx se você precisar da manipulação de valores de ponteiro de cadeia de caracteres nula.

StringCbCopy 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 da cadeia de caracteres Literal da cadeia de caracteres Função
char “cadeia de caracteres” StringCbCopyA
TCHAR TEXT("string") StringCbCopy
WCHAR L"string" StringCbCopyW
 

Observação

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

StringCbCopyEx

StringCchCopy