Função RtlStringCbCatNW (ntstrsafe.h)

Artigo
02/07/2025

As funções RtlStringCbCatNW e RtlStringCbCatNA concatenam duas cadeias de caracteres contadas por bytes, limitando o tamanho da cadeia de caracteres acrescentada.

Sintaxe

NTSTRSAFEDDI RtlStringCbCatNW(
  [in, out] NTSTRSAFE_PWSTR pszDest,
  [in]      size_t          cbDest,
  [in]      STRSAFE_PCNZWCH pszSrc,
            size_t          cbToAppend
);

Parâmetros

[in, out] pszDest

Ponteiro para um buffer que, na entrada, contém uma cadeia de caracteres terminada em nulo à qual pszSrc será concatenado. Na saída, esse é o buffer de destino que contém toda a cadeia de caracteres resultante. A cadeia de caracteres em pszSrc, até cbMaxAppend bytes, é adicionada ao final da cadeia de caracteres em pszDest e terminada com um caractere nulo.

[in] cbDest

O tamanho do buffer de destino, em bytes. O buffer deve ser grande o suficiente para incluir cadeias de caracteres e o caractere nulo de encerramento.

Para cadeias de caracteres Unicode, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Para cadeias de caracteres ANSI, o número máximo de bytes é NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Ponteiro para uma cadeia de caracteres terminada em nulo. Essa cadeia de caracteres será concatenada até o final da cadeia de caracteres contida no buffer em pszDest.

cbToAppend

O número máximo de bytes a serem acrescentados à cadeia de caracteres contida no buffer em pszDest.

Valor de retorno

A função retorna um dos valores NTSTATUS listados na tabela a seguir. Para obter informações sobre como testar valores NTSTATUS, consulte Usando 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 o parágrafo a seguir. A função retorna o valor STATUS_INVALID_PARAMETER quando: O valor em cbDest é maior que o tamanho máximo do buffer. O buffer de destino já estava cheio. Um ponteiro de NULL estava presente. O comprimento do buffer de destino era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

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 o parágrafo a seguir.

A função retorna o valor STATUS_INVALID_PARAMETER quando:

O valor em cbDest é maior que o tamanho máximo do buffer.
O buffer de destino já estava cheio.
Um ponteiro de NULL estava presente.
O comprimento do buffer de destino era zero, mas uma cadeia de caracteres de origem de comprimento diferente de zero estava presente.

Observações

rtlStringCbCatNW e rtlStringCbCatNA devem ser usados em vez das seguintes funções:

strncat
wcsncat

O tamanho, em bytes, do buffer de destino é fornecido para rtlStringCbCatNW e RtlStringCbCatNA para garantir que eles não escrevam após o final do buffer.

Use rtlStringCbCatNW para lidar com cadeias de caracteres Unicode e rtlStringCbCatNA para lidar com cadeias de caracteres ANSI. O formulário usado depende de seus dados, conforme mostrado na tabela a seguir

Tipo de dados de cadeia de caracteres	Literal de cadeia de caracteres	Função
WCHAR	L"string"	rtlStringCbCatNW
char	"string"	rtlStringCbCatNA

Se pszSrc e pszDest apontar para cadeias de caracteres sobrepostas, o comportamento da função será indefinido.

Nem pszSrc nem pszDest podem ser NULL. Se você precisar lidar com valores de ponteiro de cadeia de caracteres NULL, use RtlStringCbCatNEx.

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
de cliente com suporte mínimo	Disponível no Windows XP com Service Pack 1 (SP1) e versões posteriores do Windows.
da Plataforma de Destino	Área de trabalho
cabeçalho	ntstrsafe.h (inclua Ntstrsafe.h)
biblioteca	Ntstrsafe.lib
IRQL	Se as cadeias de caracteres que estão sendo manipuladas estiverem sempre residentes na memória, caso contrário, PASSIVE_LEVEL

Consulte também

rtlStringCbCat

rtlStringCbCatNEx

rtlStringCchCatN

Compartilhar via