Funzione StringCchCatExW (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, nonché il numero di caratteri rimasti inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.
StringCchCatEx è una sostituzione delle funzioni seguenti:
- strcat, wcscat, _tcsat
- lstrcat
- StrCat
- StrCatBuff
Sintassi
STRSAFEAPI StringCchCatExW(
[in, out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[in] STRSAFE_LPCWSTR pszSrc,
[out, optional] STRSAFE_LPWSTR *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 pszSrce 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 di entrambe le stringhe e 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 con terminazione Null.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd non è NULL e tutti i dati vengono accodati al buffer di destinazione, punta al carattere Null di terminazione alla fine della stringa.
[out, optional] pcchRemaining
Tipo: size_t*
Numero di caratteri inutilizzati in pszDest, incluso il carattere Null di terminazione. 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, viene usato il byte basso di dwFlags (0) per riempire la parte non inizializzata di pszDest dopo il carattere Null di terminazione. |
|
Considerare puntatori a stringhe null come stringhe vuote (TEXT("")). Questo flag è utile per simulare funzioni come lstrcpy. |
|
Se la funzione ha esito negativo, viene usato il byte basso di dwFlags (0) per riempire l'intero buffer pszDest e il buffer viene terminato con null. In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa preesistente o troncata nel buffer di destinazione viene sovrascritta. |
|
Se la funzione non riesce, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa preesistente o troncata nel buffer di destinazione viene sovrascritta. |
|
Se la funzione non riesce, pszDest non è toccato. Non viene aggiunto alcun elemento al contenuto originale. |
Valore restituito
Tipo: HRESULT
Questa funzione può restituire uno dei valori seguenti. Per testare il valore restituito di questa funzione, è consigliabile utilizzare il SUCCEEDED
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_CCHoppure 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 con terminazione 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.
Osservazioni
StringCchCatEx 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. StringCchCatEx sempre termina 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 puntano pszSrc e pszDest si sovrappongono.
Né pszSrc né pszDest devono essere NULL, a meno che non venga specificato il flag STRSAFE_IGNORE_NULLS, nel qual caso entrambi possono essere NULL. Tuttavia, è possibile che venga restituito un errore dovuto a spazio insufficiente anche se 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 | Valore letterale stringa | Funzione |
---|---|---|
char | "string" | 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 del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.
Fabbisogno
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 | Finestre |
intestazione |
strsafe.h |
Vedere anche
riferimento