Funzione StringCchCatNA (strsafe.h)

Articolo
03/09/2024

Concatena il numero specificato di caratteri da una stringa a un'altra. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.

StringCchCatN è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCchCatNA(
  [in, out] STRSAFE_LPSTR  pszDest,
  [in]      size_t         cchDest,
  [in]      STRSAFE_PCNZCH pszSrc,
  [in]      size_t         cchToAppend
);

Parametri

[in, out] pszDest

Tipo: LPTSTR

Il buffer di destinazione, che contiene la stringa da concatenare con pszSrc e riceverà l'intera stringa risultante. La stringa in pszSrc, fino ai caratteri cchMaxAppend , viene aggiunta alla fine della stringa in pszDest.

[in] cchDest

Tipo: size_t

Dimensioni del buffer di destinazione, in caratteri. Questo valore deve essere uguale alla lunghezza di pszSrc più la lunghezza di pszDest o cchMaxAppend (a qualsiasi valore minore). A questa somma aggiungere 1 per tenere conto del carattere null di terminazione. Il numero massimo di caratteri consentiti è STRSAFE_MAX_CCH.

[in] pszSrc

Tipo: LPCTSTR

Stringa di origine concatenata alla fine di pszDest. Questa stringa deve essere con terminazione Null.

[in] cchToAppend

Tipo: size_t

Numero massimo di caratteri da aggiungere a pszDest.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. È consigliabile utilizzare le macro SUCCEEDED e FAILED per testare il valore restituito di questa funzione.

Codice restituito	Descrizione
S_OK	I dati di origine erano presenti, le stringhe sono state concatenate senza troncamento e il buffer di destinazione risultante è con terminazione Null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cchDest è maggiore di STRSAFE_MAX_CCH oppure il buffer di destinazione è già pieno.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di concatenazione non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione con terminazione Null troncata del risultato previsto. Nelle situazioni in cui il troncamento è accettabile, questo potrebbe non essere necessariamente considerato come una condizione di errore.

Si noti che questa funzione restituisce un valore HRESULT , a differenza delle funzioni che sostituisce.

Commenti

Rispetto alle funzioni che sostituisce, StringCchCatN fornisce un'elaborazione aggiuntiva per la gestione corretta del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano sovraccarichi del buffer. StringCchCatN termina sempre null e non esegue mai l'overflow di un buffer di destinazione valido, anche se il contenuto della stringa di origine cambia durante l'operazione.

Il comportamento non è definito se le stringhe a cui punta pszSrc e pszDest si sovrappongono.

Né pszSrc né pszDest devono essere NULL. Vedere StringCchCatNEx se è necessaria la gestione dei valori del puntatore stringa Null.

StringCchCatN può essere usato nel formato generico o nelle forme più specifiche. Il tipo di dati della stringa determina la forma di questa funzione da usare.

Tipo di dati String	Stringhe letterali	Funzione
char	"stringa"	StringCchCatNA
TCHAR	TEXT("string")	StringCchCatN
WCHAR	L"string"	StringCchCatNW

Nota

L'intestazione strsafe.h definisce StringCchCatN come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti

Requisito	Valore
Client minimo supportato	Windows XP con SP2 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2003 con SP1 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	strsafe.h

Vedi anche

Riferimento

StringCbCatN

StringCchCat

StringCchCatNEx

Condividi tramite