Condividi tramite

Funzione StringCchCopyNExA (strsafe.h)

  • Articolo

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

StringCchCopyNEx aggiunge alla funzionalità di StringCchCopyN 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 alla funzione per un controllo aggiuntivo.

StringCchCopyNEx è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCchCopyNExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cchToCopy,
  [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 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.

[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
STRSAFE_FILL_BEHIND_NULL
0x00000200
 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.
STRSAFE_IGNORE_NULLS
0x00000100
 Considerare i puntatori di stringa NULL come stringhe vuote (TEXT("")).
STRSAFE_FILL_ON_FAILURE
0x00000400
 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.
STRSAFE_NULL_ON_FAILURE
0x00000800
 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.
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 di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.

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, completamente copiati senza troncamento e il buffer di destinazione risultante è con terminazione Null.
STRSAFE_E_INVALID_PARAMETER
 PszDest o pszSrc è maggiore di STRSAFE_MAX_CCH, pszDest è NULL quando sono presenti dati di origine da copiare o è 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. 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

StringCchCopyNEx 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. StringCchCopyNEx 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, StringCchCopyNEx, a differenza di strncpy, non continua a riempire 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 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.

StringCchCopyNEx 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, come illustrato nella tabella seguente.

Tipo di dati String Stringhe letterali Funzione
char "stringa" StringCchCopyNExA
TCHAR TEXT("string") StringCchCopyNEx
WCHAR L"string" StringCchCopyNExW
 

Nota

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

StringCbCopyNEx

StringCchCopyN