Funzione RtlStringCbCatNA (ntstrsafe.h)

Articolo
02/07/2025

Le funzioni RtlStringCbCatNW e RtlStringCbCatNA concatenano due stringhe con conteggio dei byte limitando al tempo stesso le dimensioni della stringa accodata.

Sintassi

NTSTRSAFEDDI RtlStringCbCatNA(
  [in, out] NTSTRSAFE_PSTR pszDest,
  [in]      size_t         cbDest,
  [in]      STRSAFE_PCNZCH pszSrc,
            size_t         cbToAppend
);

Parametri

[in, out] pszDest

Puntatore a un buffer che, in input, contiene una stringa con terminazione Null a cui pszSrc verranno concatenati. Nell'output si tratta del buffer di destinazione che contiene l'intera stringa risultante. La stringa in pszSrc, fino a byte cbToAppend, viene aggiunta alla fine della stringa in pszDest e terminata con un carattere Null.

[in] cbDest

Dimensioni del buffer di destinazione, in byte. Il buffer deve essere sufficientemente grande da includere entrambe le stringhe e il carattere Null di terminazione.

Per le stringhe Unicode, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Per le stringhe ANSI, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Puntatore a una stringa con terminazione Null. Questa stringa verrà concatenata alla fine della stringa contenuta nel buffer in pszDest.

cbToAppend

Numero massimo di byte da aggiungere alla stringa contenuta nel buffer in pszDest.

Valore restituito

La funzione restituisce uno dei valori NTSTATUS elencati nella tabella seguente. Per informazioni su come testare i valori NTSTATUS, vedere Uso di valori NTSTATUS.

Codice restituito	Descrizione
STATUS_SUCCESS	Questo esito positivo stato indica che i dati di origine erano presenti, le stringhe sono state concatenate senza troncamento e il buffer di destinazione risultante viene terminato con null.
STATUS_BUFFER_OVERFLOW	Questo avviso stato indica che l'operazione di concatenazione non è stata completata a causa di spazio nel buffer insufficiente. Il buffer di destinazione contiene una versione troncata con terminazione Null del risultato previsto.
STATUS_INVALID_PARAMETER	Questo errore stato indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente. La funzione restituisce il valore STATUS_INVALID_PARAMETER quando: Il valore in cbDest è maggiore della dimensione massima del buffer. Il buffer di destinazione era già pieno. È stato presente un puntatore NULL. La lunghezza del buffer di destinazione era zero, ma era presente una stringa di origine di lunghezza diversa da zero.

Codice restituito

Descrizione

STATUS_SUCCESS

Questo esito positivo stato indica che i dati di origine erano presenti, le stringhe sono state concatenate senza troncamento e il buffer di destinazione risultante viene terminato con null.

STATUS_BUFFER_OVERFLOW

Questo avviso stato indica che l'operazione di concatenazione non è stata completata a causa di spazio nel buffer insufficiente. Il buffer di destinazione contiene una versione troncata con terminazione Null del risultato previsto.

STATUS_INVALID_PARAMETER

Questo errore stato indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente.

La funzione restituisce il valore STATUS_INVALID_PARAMETER quando:

Il valore in cbDest è maggiore della dimensione massima del buffer.
Il buffer di destinazione era già pieno.
È stato presente un puntatore NULL.
La lunghezza del buffer di destinazione era zero, ma era presente una stringa di origine di lunghezza diversa da zero.

Osservazioni

RtlStringCbCatNW e RtlStringCbCatNA anziché le funzioni seguenti:

strncat
wcsncat

Le dimensioni, in byte, del buffer di destinazione vengono fornite per RtlStringCbCatNW e RtlStringCbCatNA per assicurarsi che non vengano scritte oltre la fine del buffer.

Usare RtlStringCbCatNW per gestire stringhe Unicode e RtlStringCbCatNA per gestire le stringhe ANSI. Il modulo usato dipende dai dati, come illustrato nella tabella seguente

Tipo di dati String	Valore letterale stringa	Funzione
WCHAR	L"string"	RtlStringCbCatNW
char	"string"	RtlStringCbCatNA

Se pszSrc e pszDest puntano a stringhe sovrapposte, il comportamento della funzione non è definito.

Né pszSrc né pszDest possono essere NULL. Se è necessario gestire valori null puntatore stringa, usare RtlStringCbCatNEx.

Per altre informazioni sulle funzioni di stringa sicura, vedere Using Safe String Functions.For more information about the safe string functions, see Using Safe String Functions.

Fabbisogno

Requisito	Valore
client minimo supportato	Disponibile in Windows XP con Service Pack 1 (SP1) e versioni successive di Windows.
piattaforma di destinazione	Desktop
intestazione	ntstrsafe.h (include Ntstrsafe.h)
libreria	Ntstrsafe.lib
IRQL	Qualsiasi se le stringhe modificate sono sempre residenti in memoria, altrimenti PASSIVE_LEVEL

Vedere anche

RtlStringCbCat

RtlStringCbCatNEx

RtlStringCchCatN

Condividi tramite