Função RtlStringCchCopyNA (ntstrsafe.h)

Artigo
02/07/2025

As funções RtlStringCchCopyNW e RtlStringCchCopyNA copiar uma cadeia de caracteres contada para um buffer, limitando o tamanho da cadeia de caracteres copiada.

Sintaxe

NTSTRSAFEDDI RtlStringCchCopyNA(
  [out] NTSTRSAFE_PSTR pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
        size_t         cchToCopy
);

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, até caracteres de cchSrc, é copiada para o buffer em pszDest e terminada com um caractere nulo.

[in] cchDest

O tamanho do buffer de destino, em caracteres. 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.

cchToCopy

O número máximo de caracteres a serem copiados de pszSrc para o buffer fornecido por pszDest.

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 ao espaço insuficiente no buffer de destino. O buffer de destino contém uma versão truncada da cadeia de caracteres copiada.
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. O buffer de destino já estava cheio. Um ponteiro de 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.

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 ao espaço insuficiente no buffer de destino. O buffer de destino contém uma versão truncada da cadeia de caracteres copiada.

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.
O buffer de destino já estava cheio.
Um ponteiro de 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.

Observações

rtlStringCchCopyNW e rtlStringCchCopyNA devem ser usados em vez de strncpy.

As funções copiam um determinado número de caracteres de uma cadeia de caracteres de origem. RtlStringCchCopyNW e RtlStringCchCopyNA receber o tamanho, em caracteres, do buffer de destino para garantir que as funções não sejam gravadas após o final do buffer.

Observe que essas funções se comportam de forma diferente de strncpy em um aspecto. Se cchSrc for maior que o número de caracteres em pszSrc, RtlStringCchCopyNW e RtlStringCchCop ode strncpy não continua a pszDest com caracteres nulos até que caracteres de cchSrc tenham sido copiados.

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

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
WCHAR	L"string"	rtlStringCchCopyNW
char	"string"	rtlStringCchCopyNA

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

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

rtlStringCbCopyN

rtlStringCchCopy

rtlStringCchCopyNEx

Partilhar via