Condividi tramite

Funzione StringCbCopyNExA (strsafe.h)

  • Articolo

Copia il numero specificato di byte 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.

StringCbCopyNEx aggiunge alla funzionalità di StringCbCopyN restituendo un puntatore alla fine della stringa di destinazione, nonché il numero di byte lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

StringCbCopyNEx è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCbCopyNExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cbDest,
  [in]            STRSAFE_PCNZCH pszSrc,
  [in]            size_t         cbToCopy,
  [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 di pszDest, in byte. Questo valore deve essere almeno grande per contenere i byte copiati (la lunghezza di pszSrc o il valore di cbSrc, che tuttavia è più piccolo) e per tenere conto del 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.

[in] cbToCopy

Tipo: size_t

Numero massimo di byte da copiare da pszSrc a pszDest.

[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
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 seguendo il carattere null terminante.
STRSAFE_IGNORE_NULLS
0x00000100
 Trattare 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 viene terminato con null. Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata restituita viene sovrascritto.
STRSAFE_NULL_ON_FAILURE
0x00000800
 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.
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("")). 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
S_OK
 I dati di origine sono presenti, completamente copiati senza troncamento e il buffer di destinazione risultante viene terminato con null.
STRSAFE_E_INVALID_PARAMETER
 PszDest o pszSrc è maggiore di STRSAFE_MAX_CCH * sizeof(TCHAR), pszDest è NULL quando sono presenti dati di origine per 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 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

StringCbCopyNEx offre 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. StringCbCopyNEx 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.

Anche se questa routine è destinata alla sostituzione di strncpy, esistono differenze nel comportamento. Se cbSrc è maggiore del numero di byte in pszSrc, StringCbCopyNEx, a differenza di strncpy, non continua a eseguire il pad pszDest con caratteri Null finché non sono stati copiati i byte cbSrc .

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.

StringCbCopyNEx 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" StringCbCopyNExA
TCHAR TEXT("string") StringCbCopyNEx
WCHAR L"string" StringCbCopyNExW
 

Nota

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

StringCbCopyN

StringCchCopyNEx