Função RtlStringCbCopyUnicodeStringEx (ntstrsafe.h)

  • Artigo

A função RtlStringCbCopyUnicodeStringEx copia o conteúdo de uma estrutura UNICODE_STRING para um destino especificado.

Sintaxe

NTSTRSAFEDDI RtlStringCbCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags
);

Parâmetros

[out] pszDest

Opcional. Um ponteiro para um buffer que recebe a cadeia de caracteres copiada. A cadeia de caracteres para a qual a estrutura UNICODE_STRING do parâmetro SourceString aponta é copiada para o buffer em pszDest e terminada com um caractere nulo. Esse ponteiro pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[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 terminação. O número máximo de bytes no buffer é NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

[in] SourceString

Opcional. Um ponteiro para uma estrutura UNICODE_STRING que contém a cadeia de caracteres a ser copiada. O número máximo de bytes na cadeia de caracteres é NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). Esse ponteiro pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[out] ppszDestEnd

Opcional. Se o chamador fornecer um ponteiro de endereço não NULL , depois que a operação de cópia for concluída, a função carregará esse endereço com um ponteiro para o terminador de cadeia de caracteres NULL resultante do buffer de destino.

[out, optional] pcbRemaining

Opcional. Se o chamador fornecer um ponteiro de endereço não NULL , a função carregará o endereço com o número de bytes não utilizados que estão no buffer para o qual pszDest aponta, incluindo bytes usados para o caractere nulo de terminação.

[in] dwFlags

Um ou mais sinalizadores e, opcionalmente, um byte de preenchimento. Os sinalizadores são definidos da seguinte maneira:

Valor Significado
STRSAFE_FILL_BEHIND_NULL Se esse sinalizador for definido e a função for bem-sucedida, o byte baixo de dwFlags será usado para preencher a parte do buffer de destino que segue o caractere nulo de terminação.
STRSAFE_IGNORE_NULLS Se esse sinalizador estiver definido, o ponteiro de origem ou destino ou ambos poderá ser NULL. RtlStringCbCopyUnicodeStringEx trata ponteiros de buffer de origem NULL como cadeias de caracteres vazias (TEXT("")), que podem ser copiadas. Os ponteiros do buffer de destino NULL não podem receber cadeias de caracteres nãompty.
STRSAFE_FILL_ON_FAILURE Se esse sinalizador estiver definido e a função falhar, o byte baixo de dwFlags será usado para preencher todo o buffer de destino e o buffer será encerrado em nulo. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE Se esse sinalizador estiver definido e a função falhar, o buffer de destino será definido como uma cadeia de caracteres vazia (TEXT("")). Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NO_TRUNCATION

Se esse sinalizador estiver definido e a função retornar STATUS_BUFFER_OVERFLOW:

  • Se STRSAFE_FILL_ON_FAILURE também for especificado, STRSAFE_NO_TRUNCATION preencherá o buffer de destino adequadamente.
  • Caso contrário, o conteúdo do buffer de destino será definido como uma cadeia de caracteres vazia, mesmo que STRSAFE_NULL_ON_FAILURE não esteja definido. STRSAFE_FILL_BEHIND_NULL é ignorado.

Retornar valor

RtlStringCbCopyUnicodeStringEx 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 insuficiente no buffer de destino. Se STRSAFE_NO_TRUNCATION estiver definido em dwFlags, o buffer de destino não será modificado. Se o sinalizador não estiver definido, o buffer de destino conterá 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 a lista a seguir.

RtlStringCbCopyUnicodeStringEx retorna o valor STATUS_INVALID_PARAMETER quando ocorre um destes procedimentos:

  • O conteúdo da estrutura UNICODE_STRING é inválido.
  • Um sinalizador inválido é especificado em dwFlags.
  • O valor em cbDest é maior que o tamanho máximo do buffer.
  • O buffer de destino (para o qual o pszDest aponta) já está cheio.
  • Um ponteiro de buffer é NULL e o sinalizador STRSAFE_IGNORE_NULLS não é especificado.
  • O ponteiro do buffer de destino é NULL, mas o tamanho do buffer não é zero.
  • O ponteiro do buffer de destino é NULL ou seu comprimento é 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 RtlStringCbCopyUnicodeStringEx usa o tamanho do buffer de destino (que o parâmetro cbDest especifica) para garantir que a operação de cópia não seja gravada após o final do buffer.

RtlStringCbCopyUnicodeStringEx adiciona à funcionalidade da função RtlStringCbCopyUnicodeString retornando um ponteiro para o final da cadeia de caracteres de destino e o número de bytes que são deixados não utilizados nessa cadeia de caracteres. Você pode passar sinalizadores para a função para controle adicional.

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

Os ponteiros *SourceString *e pszDest não podem ser NULL , a menos que o sinalizador STRSAFE_IGNORE_NULLS seja definido em dwFlags. Se STRSAFE_IGNORE_NULLS estiver definido, um ou ambos os ponteiros poderão ser NULL. Se o ponteiro pszDest for NULL, o ponteiro *SourceString *deverá ser NULL ou a estrutura UNICODE_STRING deverá descrever uma cadeia de caracteres vazia.

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 Qualquer se cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Confira também