Compartilhar via

Função RtlStringCbCopyW (ntstrsafe.h)

  • Artigo

As funções RtlStringCbCopyW e RtlStringCbCopyA copiam uma cadeia de caracteres contada por bytes em um buffer.

Sintaxe

NTSTRSAFEDDI RtlStringCbCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszSrc
);

Parâmetros

[out] pszDest

Um ponteiro para um buffer fornecido pelo chamador que recebe a cadeia de caracteres copiada. A cadeia de caracteres em pszSrc é copiada para o buffer em pszDest e terminada com um caractere nulo.

[in] cbDest

O tamanho, em bytes, do buffer de destino. O buffer deve ser grande o suficiente para a cadeia de caracteres e o caractere nulo de terminação.

Para cadeias de caracteres Unicode, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Para cadeias de caracteres ANSI, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Um ponteiro para uma cadeia de caracteres fornecida pelo chamador e terminada em nulo.

Retornar valor

A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Código de retorno Descrição
STATUS_SUCCESS
 Esse êxito status significa que os dados de origem estavam presentes, a cadeia de caracteres foi copiada sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STATUS_BUFFER_OVERFLOW
 Esse aviso status significa que a operação de cópia não foi concluída devido a espaço em buffer insuficiente. O buffer de destino contém uma versão truncada e terminada em nulo do resultado pretendido.
STATUS_INVALID_PARAMETER
 Esse erro status significa que a função recebeu um parâmetro de entrada inválido. Para obter mais informações, consulte o parágrafo a seguir.

A função retorna o valor STATUS_INVALID_PARAMETER quando:

  • O valor em cbDest é maior que o tamanho máximo do buffer.
  • O buffer de destino já estava cheio.
  • Um ponteiro NULL estava presente.
  • O comprimento do buffer de destino era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Comentários

RtlStringCbCopyA e RtlStringCbCopyW devem ser usados em vez das seguintes funções:

  • strcpy
  • wcscpy
RtlStringCbCopyA e RtlStringCbCopyW não são substituições para strncpy. Para substituir strncpy, use RtlStringCbCopyN ou RtlStringCbCopyNEx.

O tamanho do buffer de destino é fornecido à função para garantir que RtlStringCbCopy não escreva além do final do buffer.

Use RtlStringCbCopyW para manipular cadeias de caracteres Unicode e RtlStringCbCopyA para manipular cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir.

Tipos de dados de cadeia de caracteres Cadeia de caracteres literal Função
WCHAR L"string" RtlStringCbCopyW
char “cadeia de caracteres” RtlStringCbCopyA
 

Se pszSrc e pszDest apontarem para cadeias de caracteres sobrepostas, o comportamento da função será indefinido.

Nem pszSrc nem pszDest podem ser NULL. Se você precisar manipular valores de ponteiro de cadeia de caracteres NULL , use RtlStringCbCopyEx.

Para obter mais informações sobre as funções de cadeia de caracteres seguras, consulte Usando funções de cadeia de caracteres seguras.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
Plataforma de Destino Área de Trabalho
Cabeçalho ntstrsafe.h (inclua Ntstrsafe.h)
Biblioteca Ntstrsafe.lib
IRQL Qualquer se cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Confira também

RtlStringCbCopyEx

RtlStringCchCopy