Funzione StringCbCopyA (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.

StringCbCopy è una sostituzione delle funzioni seguenti:

strcpy, wcscpy, _tcscpy
lstrcpy
StrCpy

Sintassi

STRSAFEAPI StringCbCopyA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cbDest,
  [in]  STRSAFE_LPCSTR pszSrc
);

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

Puntatore a un buffer contenente la stringa di origine. Questa stringa di origine deve essere con terminazione Null.

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	Il valore in cbDest è minore di `sizeof(TCHAR)` o maggiore del valore massimo consentito.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione troncata 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, StringCbCopy 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. StringCbCopy 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. Vedere StringCbCopyEx se è necessaria la gestione dei valori del puntatore di stringa Null.

StringCbCopy 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.

Tipo di dati String	Valore letterale stringa	Funzione
char	"string"	StringCbCopyA
TCHAR	TEXT("string")	StringCbCopy
WCHAR	L"string"	StringCbCopyW

Nota

L'intestazione strsafe.h definisce StringCbCopy 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

StringCbCopyEx

StringCchCopy

Condividi tramite