Funzione StringCchCopyNA (strsafe.h)

Articolo
08/26/2023

Copia il numero specificato di caratteri da una stringa a un'altra. Le dimensioni del buffer di destinazione vengono fornite alla funzione per garantire che StringCchCopyN non scriva oltre la fine del buffer.

StringCchCopyN è una sostituzione delle funzioni seguenti:

strncpy, wcsncpy, _tcsncpy

Sintassi

STRSAFEAPI StringCchCopyNA(
  [out] STRSAFE_LPSTR  pszDest,
  [in]  size_t         cchDest,
  [in]  STRSAFE_PCNZCH pszSrc,
  [in]  size_t         cchToCopy
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve i caratteri copiati.

[in] cchDest

Tipo: size_t

Dimensioni di pszDest, in caratteri. Questo valore deve essere sufficientemente grande da contenere i caratteri copiati (la lunghezza di pszSrc o il valore di cchSrc, a qualsiasi valore minore) più 1 per tenere conto 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 leggibile fino ai caratteri cchSrc o a un carattere di terminazione Null, a qualsiasi motivo venga visualizzato per primo.

[in] cchToCopy

Tipo: size_t

Numero massimo di caratteri da copiare da pszSrc a pszDest.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. È consigliabile utilizzare le macro SUCCEEDED e FAILED per testare il valore restituito di questa funzione.

Codice restituito	Descrizione
S_OK	I dati di origine erano presenti, i caratteri sono stati copiati da pszSrc senza troncamento e il buffer di destinazione risultante è con terminazione Null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cchDest è maggiore di STRSAFE_MAX_CCH oppure il buffer di destinazione è già pieno.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione con terminazione Null troncata 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

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

Anche se questa routine è intesa come sostituzione di strncpy, esistono differenze nel comportamento. Se cchSrc è maggiore del numero di caratteri in pszSrc, StringCchCopyN, a differenza di strncpy, non continua a inserire pszDest con caratteri Null finché non vengono copiati i caratteri cchSrc .

Il comportamento non è definito se le stringhe a cui punta pszSrc e pszDest si sovrappongono.

Né pszSrc né pszDest devono essere NULL. Vedere StringCchCopyNEx se è necessaria la gestione dei valori del puntatore di stringa Null.

StringCchCopyN 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	Stringhe letterali	Funzione
char	"stringa"	StringCchCopyNA
TCHAR	TEXT("string")	StringCchCopyN
WCHAR	L"string"	StringCchCopyNW

Nota

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


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

StringCbCopyN

StringCchCopy

StringCchCopyNEx

Condividi tramite