Função RtlUnicodeStringCbCatN (ntstrsafe.h)

  • Artigo

A função RtlUnicodeStringCbCatN concatena duas cadeias de caracteres contidas em estruturas UNICODE_STRING enquanto limita o tamanho da cadeia de caracteres copiada.

Sintaxe

NTSTRSAFEDDI RtlUnicodeStringCbCatN(
  [in, out] PUNICODE_STRING  DestinationString,
  [in]      PCUNICODE_STRING SourceString,
  [in]      size_t           cbToAppend
);

Parâmetros

[in, out] DestinationString

Um ponteiro para uma estrutura UNICODE_STRING . Essa estrutura inclui um buffer que, na entrada, contém uma cadeia de caracteres de destino para a qual a cadeia de caracteres de origem será concatenada. Na saída, esse buffer é o buffer de destino que contém toda a cadeia de caracteres resultante. A cadeia de caracteres de origem é adicionada ao final da 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á adicionada ao final da 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] cbToAppend

O número máximo de bytes a serem acrescentados à cadeia de caracteres que o parâmetro DestinationString descreve.

Retornar valor

RtlUnicodeStringCbCatN 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, as cadeias de caracteres foram concatenadas sem truncamento e o buffer de destino resultante foi encerrado em nulo.
STATUS_BUFFER_OVERFLOW
 Esse aviso status significa que a operação de concatenação não foi concluída devido a 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.
 

RtlUnicodeStringCbCatN retorna o valor STATUS_INVALID_PARAMETER quando ocorre um dos seguintes:

  • 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 cbToAppend é 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 RtlUnicodeStringCbCatN usa o tamanho do buffer de destino para garantir que a operação de concatenação 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 SourceString e DestinationString não podem ser NULL. Se você precisar manipular valores de ponteiro NULL , use a função RtlUnicodeStringCbCatNEx .

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

RtlUnicodeStringCbCatNEx

RtlUnicodeStringCchCatN

UNICODE_STRING