Função RtlUnicodeStringCbCopyStringN (ntstrsafe.h)

  • Artigo

A função RtlUnicodeStringCbCopyStringN copia uma cadeia de caracteres em uma estrutura UNICODE_STRING enquanto limita o tamanho da cadeia de caracteres copiada.

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringN(
  [out] PUNICODE_STRING  DestinationString,
  [in]  NTSTRSAFE_PCWSTR pszSrc,
  [in]  size_t           cbToCopy
);

Parâmetros

[out] DestinationString

Um ponteiro para uma estrutura UNICODE_STRING que recebe a cadeia de caracteres copiada. A cadeia de caracteres para a qual o parâmetro pszSrc aponta (excluindo o nulo de terminação) é copiada para o buffer para o qual a estrutura UNICODE_STRING do parâmetro DestinationString aponta. O número máximo de bytes na cadeia de caracteres é NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

[in] pszSrc

Um ponteiro para a cadeia de caracteres a ser copiada.

[in] cbToCopy

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

Retornar valor

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 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 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 a lista 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.

Comentários

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 termina 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 pszSrc e DestinationString não podem ser NULL. Se você precisar manipular valores de ponteiro 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
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 PASSIVE_LEVEL

Confira também

RtlUnicodeStringCbCopyNEx

RtlUnicodeStringCchCopyN

UNICODE_STRING