Compartilhar via

Função StringCbCopyExA (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 após o final desse buffer.

StringCbCopyEx adiciona à funcionalidade de stringCbCopy retornando um ponteiro para o final da cadeia de caracteres de destino, bem como o número de bytes deixados não utilizados nessa cadeia de caracteres. Sinalizadores também podem ser passados para a função para controle adicional.

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

Sintaxe

STRSAFEAPI StringCbCopyExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_LPCSTR pszSrc,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcbRemaining,
  [in]            DWORD          dwFlags
);

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

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

[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] pcbRemaining

Tipo: size_t*

O número de bytes não utilizados em pszDest, incluindo aqueles usados para o caractere nulo de terminação. Se pcbRemaining for NULL, a contagem não será mantida ou retornada.

[in] dwFlags

Tipo: DWORD

Um ou mais dos valores a seguir.

Valor Significado
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Se a função for bem-sucedida, o byte baixo de dwFlags (0) será usado para preencher a parte não inicializada de pszDest após o término do caractere nulo.
STRSAFE_IGNORE_NULLS
0x00000100
 Trate ponteiros de cadeia de caracteres NULL como cadeias de caracteres vazias (TEXT(")). Esse sinalizador é útil para emular funções como lstrcpy.
STRSAFE_FILL_ON_FAILURE
0x00000400
 Se a função falhar, o byte baixo de dwFlags (0) será usado para preencher todo o buffer de pszDest e o buffer será encerrado em nulo. No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada retornada é substituída.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Se a função falhar, pszDest será definido como uma cadeia de caracteres vazia (TEXT(")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada é substituída.
STRSAFE_NO_TRUNCATION
0x00001000
 Como no caso de STRSAFE_NULL_ON_FAILURE, se a função falhar, pszDest é definido como uma cadeia de caracteres vazia (TEXT("")). No caso de uma falha de STRSAFE_E_INSUFFICIENT_BUFFER, qualquer cadeia de caracteres truncada é substituída.

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
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
 pszDest é NULL quando há dados de origem presentes para copiar ou um sinalizador inválido foi passado.
STRSAFE_E_INSUFFICIENT_BUFFER
 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

Em comparação com as funções que ele substitui, StringCbCopyEx 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. StringCbCopyEx 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, 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.

stringCbCopyEx 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" StringCbCopyExA
TCHAR TEXT("string") StringCbCopyEx
WCHAR L"string" StringCbCopyExW
 

Nota

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

StringCbCopy

StringCchCopyEx