Função RtlUnicodeStringCbCopyN (ntstrsafe.h)

Artigo
02/07/2025

A função RtlUnicodeStringCbCopyN copia uma cadeia de caracteres de uma estrutura UNICODE_STRING para outra, limitando o tamanho da cadeia de caracteres copiada.

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringCbCopyN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString,
  [in]  size_t           cbToCopy
);

Parâmetros

[out] DestinationString

Um ponteiro para uma estrutura de UNICODE_STRING que recebe a cadeia de caracteres copiada. A cadeia de caracteres à qual a estrutura UNICODE_STRING do parâmetro sourceString aponta é copiada para o buffer ao qual a estrutura UNICODE_STRING do parâmetro DestinationString aponta. O número máximo de bytes no buffer de cadeia de caracteres da estrutura de DestinationString é NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Um ponteiro para uma estrutura de UNICODE_STRING que contém a cadeia de caracteres a ser copiada. O número máximo de bytes no buffer de cadeia de caracteres da estrutura é NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] cbToCopy

O número de bytes a serem copiados da origem para o destino.

Valor de retorno

RtlUnicodeStringCbCopyN retorna um dos seguintes 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.
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 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.

RtlUnicodeStringCbCopyN retorna o valor STATUS_INVALID_PARAMETER quando ocorre um destes procedimentos:

O conteúdo da estrutura UNICODE_STRING é inválido.
O buffer de destino já está cheio.
Um ponteiro de buffer é NULL.
O comprimento do buffer de destino é zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero está presente.
O valor do parâmetro cbToCopy é maior que NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Observações

A função RtlUnicodeStringCbCopyN usa o tamanho do buffer de destino para garantir que a operação de cópia não seja gravada após o final do buffer. A função não encerrar a cadeia de caracteres resultante com um valor de caractere nulo (ou seja, com zero).

Se as cadeias de caracteres de origem e destino se sobrepõem, o comportamento da função será indefinido.

Os ponteiros SourceString e DestinationString não podem ser NULL. Se você precisar lidar com valores de ponteiro de NULL, use a função RtlUnicodeStringCbCopyNEx.

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

rtlUnicodeStringCbCopyNEx

rtlUnicodeStringCchCopyN

UNICODE_STRING

Compartilhar via