Função RtlUnicodeStringCbCopyStringNEx (ntstrsafe.h)

  • Artigo

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

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Parâmetros

[out] DestinationString

Opcional. 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). DestinationString pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[in] pszSrc

Opcional. Um ponteiro para a cadeia de caracteres a ser copiada. Esse ponteiro pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[in] cbToCopy

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

[out, optional] RemainingString

Opcional. Se o chamador fornecer um ponteiro não NULL para uma estrutura UNICODE_STRING , a função definirá o membro Buffer dessa estrutura como o final da cadeia de caracteres concatenada, definirá o membro Length da estrutura como zero e definirá o membro MaximumLength da estrutura como o número de bytes restantes no buffer de destino. RemainingString pode ser NULL, mas somente se STRSAFE_IGNORE_NULLS estiver definido em dwFlags.

[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 último caractere na cadeia de caracteres.
STRSAFE_IGNORE_NULLS Se esse sinalizador estiver definido, o ponteiro de origem ou destino, ou ambos, poderá ser NULL. RtlUnicodeStringCbCopyStringNEx trata ponteiros de buffer de origem NULL como cadeias de caracteres vazias (TEXT("")), que podem ser copiadas. Os ponteiros de buffer de destino NULL não podem receber cadeias de caracteres não vazias.
STRSAFE_FILL_ON_FAILURE Se esse sinalizador for definido e a função falhar, o byte baixo de dwFlags será usado para preencher todo o buffer de destino. Essa operação substitui qualquer conteúdo de buffer pré-existente.
STRSAFE_NULL_ON_FAILURE Se esse sinalizador for 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.
STRSAFE_ZERO_LENGTH_ON_FAILURE Se esse sinalizador for definido e a função retornar STATUS_BUFFER_OVERFLOW, o comprimento da cadeia de caracteres de destino será definido como zero bytes.

Retornar valor

RtlUnicodeStringCbCopyStringNEx retorna um dos seguintes valores NTSTATUS.

Código de retorno Descrição
STATUS_SUCCESS Esse sucesso status significa que os dados de origem estavam presentes e as cadeias de caracteres foram concatenadas sem truncamento.
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.

RtlUnicodeStringCbCopyStringNEx retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes procedimentos:

  • O conteúdo de uma estrutura UNICODE_STRING é inválido.
  • Um sinalizador inválido é especificado em dwFlags.
  • O buffer de destino já está cheio.
  • Um ponteiro de buffer é NULL e o sinalizador STRSAFE_IGNORE_NULLS não é especificado em dwFlags.
  • 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.
  • 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 RtlUnicodeStringCbCopyStringNEx 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. Por padrão, a função não encerra a cadeia de caracteres resultante com um valor de caractere nulo (ou seja, com zero). Como opção, o chamador pode usar o sinalizador STRSAFE_FILL_BEHIND e um valor de byte de preenchimento de zero para encerrar nulo uma cadeia de caracteres resultante que não ocupa todo o buffer de destino.

RtlUnicodeStringCbCopyStringNEx adiciona à funcionalidade da função RtlUnicodeStringCbCopyStringN retornando uma estrutura UNICODE_STRING que identifica o final da cadeia de caracteres de destino e o número de bytes não utilizados nessa cadeia de caracteres. Você pode passar sinalizadores RtlUnicodeStringCbCopyStringNEx para controle adicional.

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 , a menos que o sinalizador STRSAFE_IGNORE_NULLS esteja definido em dwFlags. Se STRSAFE_IGNORE_NULLS estiver definido, um ou ambos os ponteiros poderão ser NULL. Se o ponteiro DestinationString for NULL, o ponteiro pszSrc deverá ser NULL ou apontar para 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 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 Qualquer se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Confira também