Funzione StringCbCopyExA (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.
StringCbCopyEx aggiunge alla funzionalità di StringCbCopy restituendo un puntatore alla fine della stringa di destinazione e il numero di byte lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.
StringCbCopyEx è una sostituzione delle funzioni seguenti:
Sintassi
STRSAFEAPI StringCbCopyExA(
[out] STRSAFE_LPSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCSTR pszSrc,
[out, optional] STRSAFE_LPSTR *ppszDestEnd,
[out, optional] size_t *pcbRemaining,
[in] DWORD dwFlags
);
Parametri
[out] pszDest
Tipo: LPTSTR
Buffer di destinazione, che riceve la stringa copiata.
[in] cbDest
Tipo: size_t
Dimensioni del buffer di destinazione, in byte. Questo valore deve considerare la lunghezza di pszSrc più il carattere null terminante. Il numero massimo di byte consentiti è STRSAFE_MAX_CCH * sizeof(TCHAR).
[in] pszSrc
Tipo: LPCTSTR
Stringa di origine. 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 copiati nel buffer di destinazione, questo punta al carattere Null terminante alla fine della stringa.
[out, optional] pcbRemaining
Tipo: size_t*
Numero di byte inutilizzati in pszDest, inclusi quelli usati per il carattere null terminante. Se pcbRemaining è 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 troncata restituita 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 troncata viene sovrascritta. |
|
Come nel caso di STRSAFE_NULL_ON_FAILURE, 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 troncata viene sovrascritta. |
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 sono presenti, completamente copiati senza troncamento e il buffer di destinazione risultante viene terminato con null. |
|
PszDest è NULL quando sono presenti dati di origine per copiare o è stato 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 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
Rispetto alle funzioni sostituite, StringCbCopyEx 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 l'overrun del buffer. StringCbCopyEx termina sempre con 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.
StringCbCopyEx può essere usato nel formato generico o nelle relative 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" | StringCbCopyExA |
| TCHAR | TEXT("string") | StringCbCopyEx |
| WCHAR | L"string" | StringCbCopyExW |
Nota
L'intestazione strsafe.h definisce StringCbCopyEx 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