Função RtlStringCchCopyW (ntstrsafe.h)

Artigo
02/07/2025

As funções RtlStringCchCopyW e RtlStringCchCopyA copiar uma cadeia de caracteres de origem terminada em nulo em um buffer de destino de comprimento especificado.

Sintaxe

NTSTRSAFEDDI RtlStringCchCopyW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [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] cchDest

O tamanho, em caracteres, do buffer de destino. O número máximo de caracteres permitido é NTSTRSAFE_MAX_CCH.

[in] pszSrc

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

Valor de retorno

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 cchDest é maior que o tamanho máximo do buffer. Um ponteiro de NULL estava presente. O comprimento do buffer de destino era zero na entrada.

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 cchDest é maior que o tamanho máximo do buffer.
Um ponteiro de NULL estava presente.
O comprimento do buffer de destino era zero na entrada.

Observações

rtlStringCchCopyW e rtlStringCchCopyA devem ser usados em vez das seguintes funções:

strcpy
wcscpy

Essas funções não são substituições para strncpy. Use rtlStringCchCopyN ou rtlStringCchCopyNEx para substituir strncpy.

O tamanho, em caracteres, do buffer de destino é fornecido para rtlStringCchCopyW e RtlStringCchCopyA para garantir que eles não escrevam após o final do buffer.

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

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
WCHAR	L"string"	rtlStringCchCopyW
char	"string"	rtlStringCchCopyA

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

Nem pszSrc nem pszDest podem ser NULL. Se você precisar lidar com valores de ponteiro de cadeia de caracteres NULL, use RtlStringCchCopyEx.

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
de cliente com suporte mínimo	Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	ntstrsafe.h (inclua Ntstrsafe.h)
biblioteca	Ntstrsafe.lib
IRQL	Se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Consulte também

rtlStringCbCopy

RtlStringCchCopyEx

Compartilhar via