Função RtlStringCbCopyNA (ntstrsafe.h)

Artigo
02/07/2025

As funções RtlStringCbCopyNW e RtlStringCbCopyNA copiam uma cadeia de caracteres contada por bytes para um buffer, limitando o tamanho da cadeia de caracteres copiada.

Sintaxe

NTSTRSAFEDDI RtlStringCbCopyNA(
  [out] NTSTRSAFE_PSTR pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_PCNZCH pszSrc,
        size_t         cbToCopy
);

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é cbSrc bytes, é 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 encerramento.

Para cadeias de caracteres Unicode, o número máximo de bytes é NTSTRSAFE_MAX_CCH * tamanho de(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.

cbToCopy

O número máximo de bytes a serem copiados de pszSrc para 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 cbDest é 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 cbDest é 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

rtlStringCbCopyNW e rtlStringCbCopyNA devem ser usados em vez de strncpy . No entanto, essas funções diferem no comportamento. Se cbSrc for maior que o número de bytes em pszSrc, as funções de rtlStringCbCopyN , ao contrário de strncpy, não preencherão pszDest com caracteres nulos até que cbSrc bytes tenham sido copiados.

RtlStringCbCopyN copia um determinado número de bytes de uma cadeia de caracteres de origem. O tamanho, em bytes, do buffer de destino é fornecido à função para garantir que RtlStringCbCopyN não escreva após o final desse buffer.

Use RtlStringCbCopyNW para manipular cadeias de caracteres Unicode e rtlStringCbCopyNA para lidar com 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"	rtlStringCbCopyNW
char	"string"	rtlStringCbCopyNA

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, consulte RtlStringCbCopyNEx.

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

rtlStringCbCopyNEx

rtlStringCchCopyN

Compartilhar via