Funzione StringCchCopyExA (strsafe.h)
Copia una stringa in un'altra. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.
StringCchCopyEx aggiunge alla funzionalità di StringCchCopy 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 a questa funzione per un controllo aggiuntivo.
StringCchCopyEx è una sostituzione delle funzioni seguenti:
Sintassi
STRSAFEAPI StringCchCopyExA(
[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
[out] pszDest
Tipo: LPTSTR
Buffer di destinazione, che riceve la stringa copiata.
[in] cchDest
Tipo: size_t
Dimensioni del buffer di destinazione, in caratteri. Questo valore deve essere uguale alla lunghezza di pszSrc più 1 per tenere conto della stringa di origine copiata e del carattere null di terminazione. Il numero massimo di caratteri consentiti è STRSAFE_MAX_CCH.
[in] pszSrc
Tipo: LPCTSTR
Stringa di origine. Questa stringa deve essere con terminazione Null.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd è diverso da NULL e tutti i dati vengono copiati nel 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, il byte basso di dwFlags (0) viene usato per riempire la parte non inizializzata di pszDest dopo il carattere null di terminazione. |
|
Considerare i puntatori di stringa NULL come stringhe vuote (TEXT("")). Questo flag è utile per emulare 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 è con terminazione Null. In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata restituita viene sovrascritta. |
|
Se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta. |
|
Come nel caso di STRSAFE_NULL_ON_FAILURE, se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta. |
Valore restituito
Tipo: HRESULT
È consigliabile utilizzare le macro SUCCEEDED e FAILED per testare il valore restituito di questa funzione.
| Codice restituito | Descrizione |
|---|---|
|
I dati di origine erano presenti, completamente copiati senza troncamento e il buffer di destinazione risultante è con terminazione Null. |
|
PszDest è NULL quando sono presenti dati di origine da copiare o viene passato un flag non valido. |
|
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. 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, StringCchCopyEx 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. StringCchCopyEx 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 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 i valori NULL vengono ignorati.
StringCchCopyEx può essere usato nel formato generico o nei moduli più specifici. Il tipo di dati della stringa determina la forma di questa funzione da usare.
| Tipo di dati String | Stringhe letterali | Funzione |
|---|---|---|
| char | "stringa" | StringCchCopyExA |
| TCHAR | TEXT("string") | StringCchCopyEx |
| WCHAR | L"string" | StringCchCopyExW |
Nota
L'intestazione strsafe.h definisce StringCchCopyEx 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