Função RtlUnicodeStringInit (ntstrsafe.h)

  • Artigo

A função RtlUnicodeStringInit inicializa uma estrutura UNICODE_STRING .

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringInit(
  [out]          PUNICODE_STRING  DestinationString,
  [in, optional] NTSTRSAFE_PCWSTR pszSrc
);

Parâmetros

[out] DestinationString

Um ponteiro para uma estrutura UNICODE_STRING a ser inicializada. O ponteiro pszSrc é copiado para a estrutura UNICODE_STRING do parâmetro DestinationString. O número máximo de caracteres na cadeia de caracteres para a qual pszSrc aponta é NTSTRSAFE_UNICODE_STRING_MAX_CCH.

[in, optional] pszSrc

Opcional. Um ponteiro para uma constante de cadeia de caracteres terminada em nulo. Esse ponteiro de cadeia de caracteres será copiado para o membro Buffer da estrutura UNICODE_STRING apontada pelo parâmetro DestinationString . Esse ponteiro de cadeia de caracteres pode ser NULL.

Retornar valor

RtlUnicodeStringInit 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_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.
 

RtlUnicodeStringInit retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes:

  • O comprimento da cadeia de caracteres para a qual o parâmetro pszSrc aponta é maior que NTSTRSAFE_UNICODE_STRING_MAX_CCH caracteres.
  • O ponteiro DestinationString é NULL, mas o ponteiro pszSrc não é NULL.
Para obter informações sobre como testar valores NTSTATUS, consulte Usando valores NTSTATUS.

Comentários

A função RtlUnicodeStringInit faz o seguinte:

  • Define o membro Length da estrutura UNICODE_STRING apontada pelo parâmetro pszSrc para o comprimento, em bytes, da cadeia de caracteres para a qual o parâmetro pszSrc aponta.
  • Define o membro MaximumLength da estrutura UNICODE_STRING para o comprimento, em bytes, da cadeia de caracteres que o parâmetro pszSrc aponta para mais 2 bytes.
  • Define o membro Buffer da estrutura UNICODE_STRING para o endereço especificado pelo parâmetro pszSrc .
O ponteiro DestinationString não deve ser NULL. Se você precisar especificar valores de ponteiro DestinationStringNULL, use a função RtlUnicodeStringInitEx.

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 a partir do Windows XP com Service Pack 1 (SP1).
Plataforma de Destino Área de Trabalho
Cabeçalho ntstrsafe.h (inclua Ntstrsafe.h)
Biblioteca Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Confira também

RtlUnicodeStringInitEx

UNICODE_STRING