Funzione StringCbCopyNW (strsafe.h)

Articolo
11/20/2024

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.

StringCbCopyN è una sostituzione delle funzioni seguenti:

strncpy, wcsncpy, _tcsncpy

Sintassi

STRSAFEAPI StringCbCopyNW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
  [in]  size_t          cbToCopy
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve i caratteri copiati.

[in] cbDest

Tipo: size_t

Dimensioni in byte di pszDest. Questo valore deve essere sufficientemente grande da contenere i byte copiati (le dimensioni di pszSrc o il valore di cbSrc, a qualsiasi valore minore) e tenere conto anche del carattere null di terminazione. Il numero massimo di caratteri consentiti è STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Tipo: LPCTSTR

Stringa di origine. Questa stringa deve essere con terminazione Null.

[in] cbToCopy

Tipo: size_t

Numero massimo di byte da copiare da pszSrc a pszDest.

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, i dati sono stati copiati da pszSrc senza troncamento e il buffer di destinazione risultante viene terminato con null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cbDest è maggiore di `STRSAFE_MAX_CCH * sizeof(TCHAR)`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 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

stringCbCopyN 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. StringCbCopyN 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.

Anche se questa routine è destinata a sostituire strncpy, esistono differenze nel comportamento. Se cbSrc è maggiore del numero di byte in pszSrc, StringCbCopyN, a differenza di strncpy, non continua a riempire pszDest con caratteri Null finché non vengono copiati byte cbS rc.

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

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

stringCbCopyN 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	Valore letterale stringa	Funzione
char	"string"	StringCbCopyNA
TCHAR	TEXT("string")	stringCbCopyN
WCHAR	L"string"	StringCbCopyNW

Nota

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

StringCbCopyNEx

StringCchCopyN

Condividi tramite