Funzione StringCbCopyExA (strsafe.h)

Articolo
11/20/2024

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, nonché il numero di byte rimasti inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

StringCbCopyEx è una sostituzione delle funzioni seguenti:

strcpy, wcscpy, _tcscpy
lstrcpy
StrCpy

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 di terminazione. Il numero massimo di byte consentiti è STRSAFE_MAX_CCH * sizeof(TCHAR).

[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 non è NULL e tutti i dati vengono copiati nel buffer di destinazione, punta al carattere Null di terminazione alla fine della stringa.

[out, optional] pcbRemaining

Tipo: size_t*

Numero di byte inutilizzati in pszDest, inclusi quelli usati per il carattere Null di terminazione. Se è NULL, il conteggio non viene mantenuto o restituito.

[in] dwFlags

Tipo: DWORD

Uno o più dei valori seguenti.

Valore	Significato
STRSAFE_FILL_BEHIND_NULL 0x00000200	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.
STRSAFE_IGNORE_NULLS 0x00000100	Considerare puntatori a stringhe null come stringhe vuote (TEXT("")). Questo flag è utile per simulare funzioni come lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	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 troncata restituita viene sovrascritta.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se la funzione non riesce, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa troncata viene sovrascritta.
STRSAFE_NO_TRUNCATION 0x00001000	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 STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa troncata viene sovrascritta.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. Per testare il valore restituito di questa funzione, è consigliabile utilizzare il SUCCEEDED e MACRO FAILED.

Codice restituito	Descrizione
S_OK	I dati di origine erano presenti, completamente copiati senza troncamento e il buffer di destinazione risultante viene terminato con null.
STRSAFE_E_INVALID_PARAMETER	pszDest è NULL quando sono presenti dati di origine da copiare oppure è stato passato un flag non valido.
STRSAFE_E_INSUFFICIENT_BUFFER	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

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 sovraccarichi del buffer. StringCbCopyEx 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.

StringCbCopyEx 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	Valore letterale stringa	Funzione
char	"string"	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 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

StringCbCopy

StringCchCopyEx

Condividi tramite