Função RtlUnicodeStringCopy (ntstrsafe.h)

A função RtlUnicodeStringCopy copia uma cadeia de caracteres de uma estrutura UNICODE_STRING para outra.

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringCopy(
  [out] PUNICODE_STRING  DestinationString,
  [in]  PCUNICODE_STRING SourceString
);

Parâmetros

[out] DestinationString

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

[in] SourceString

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

Retornar valor

RtlUnicodeStringCopy 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 a espaço em buffer insuficiente. O buffer de destino contém uma versão truncada da cadeia de caracteres de origem.
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.

 

RtlUnicodeStringCopy retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes:

• O conteúdo de uma 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.

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

Comentários

A função RtlUnicodeStringCopy 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. Se a cadeia de caracteres precisar ser truncada no final do buffer de destino, a função não encerrará a cadeia de caracteres resultante com um caractere nulo.

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 manipular valores de ponteiro NULL , use a função RtlUnicodeStringCopyEx .

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

RtlUnicodeStringCopyEx

UNICODE_STRING