Funzione StringCchCatExA (strsafe.h)
Concatena una stringa a un'altra stringa. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.
StringCchCatEx aggiunge alla funzionalità di StringCchCat restituendo un puntatore alla fine della stringa di destinazione e il numero di caratteri lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.
StringCchCatEx è una sostituzione delle funzioni seguenti:
Sintassi
STRSAFEAPI StringCchCatExA(
[in, out] STRSAFE_LPSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags
);
Parametri
[in, out] pszDest
Tipo: LPTSTR
Buffer di destinazione che contiene la stringa da concatenare a pszSrc e che riceverà l'intera stringa risultante. La stringa in pszSrc 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 più 1 per tenere conto sia delle stringhe che del carattere Null di terminazione. Il numero massimo di caratteri consentiti è STRSAFE_MAX_CCH.
[in] pszSrc
Tipo: LPCTSTR
Stringa di origine da concatenare alla fine di pszDest. Questa stringa deve essere terminata con null.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd non è NULL e tutti i dati vengono aggiunti al buffer di destinazione, questo punta al carattere Null terminante alla fine della stringa.
[out, optional] pcchRemaining
Tipo: size_t*
Numero di caratteri inutilizzati in pszDest, incluso il carattere null terminante. Se pcchRemaining è NULL, il conteggio non viene mantenuto o restituito.
[in] dwFlags
Tipo: DWORD
Uno o più dei valori seguenti.
| Valore | Significato |
|---|---|
|
Se la funzione ha esito positivo, il byte basso di dwFlags (0) viene usato per riempire la parte non inizializzata di pszDest seguendo il carattere null terminante. |
|
Trattare i puntatori di stringa NULL come stringhe vuote (TEXT("")). Questo flag è utile per simulare funzioni come lstrcpy. |
|
Se la funzione ha esito negativo, il byte basso di dwFlags (0) viene usato per riempire l'intero buffer pszDest e il buffer viene terminato con null. Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa pre-esistente o troncata nel buffer di destinazione viene sovrascritto. |
|
Se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa pre-esistente o troncata nel buffer di destinazione viene sovrascritto. |
|
Se la funzione ha esito negativo, pszDest non è toccato. Non viene aggiunto nulla al contenuto originale. |
Valore restituito
Tipo: HRESULT
Questa funzione può restituire uno dei valori seguenti. È consigliabile usare le macro SUCCESSED e FAILED per testare il valore restituito di questa funzione.
| Codice restituito | Descrizione |
|---|---|
|
I dati di origine erano presenti, le stringhe erano completamente concatenate senza troncamento e il buffer di destinazione risultante viene terminato con null. |
|
Il valore in cchDest è 0 o maggiore di STRSAFE_MAX_CCH oppure il buffer di destinazione è già pieno. |
|
L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. A seconda del valore di dwFlags, il buffer di destinazione può contenere una versione troncata e terminata null del risultato previsto. In 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 sostituite.
Commenti
StringCchCatEx offre un'elaborazione aggiuntiva per la gestione corretta del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano l'overrun del buffer. StringCchCatEx termina sempre null e non esegue mai il 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 puntate da pszSrc e pszDest sovrapposte.
Né pszSrc né pszDest devono essere NULL a meno che non sia specificato il flag di STRSAFE_IGNORE_NULLS , in cui entrambi possono essere NULL. Tuttavia, un errore dovuto a spazio insufficiente può essere restituito anche se i valori NULL vengono ignorati.
StringCchCatEx 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, come illustrato nella tabella seguente.
| Tipo di dati String | Stringhe letterali | Funzione |
|---|---|---|
| char | "stringa" | StringCchCatExA |
| TCHAR | TEXT("string") | StringCchCatEx |
| WCHAR | L"string" | StringCchCatExW |
Nota
L'intestazione strsafe.h definisce StringCchCatEx come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.
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