Funzione RtlStringCchCopyNW (ntstrsafe.h)

Articolo
05/03/2024

Le funzioni RtlStringCchCopyNW e RtlStringCchCopyNA copiano una stringa con conteggio dei caratteri in un buffer, limitando al tempo stesso le dimensioni della stringa copiata.

Sintassi

NTSTRSAFEDDI RtlStringCchCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cchToCopy
);

Parametri

[out] pszDest

Puntatore a un buffer fornito dal chiamante che riceve la stringa copiata. La stringa in pszSrc, fino ai caratteri cchSrc , viene copiata nel buffer in pszDest e terminata con un carattere Null.

[in] cchDest

Dimensioni del buffer di destinazione, in caratteri. Il numero massimo di caratteri consentiti è NTSTRSAFE_MAX_CCH.

[in] pszSrc

Puntatore a una stringa con terminazione Null fornita dal chiamante.

cchToCopy

Numero massimo di caratteri da copiare da pszSrc al buffer fornito da pszDest.

Valore restituito

La funzione restituisce uno dei valori NTSTATUS elencati nella tabella seguente. Per informazioni su come testare i valori NTSTATUS, vedere Utilizzo di valori NTSTATUS.

Codice restituito	Descrizione
STATUS_SUCCESS	Questo stato di esito positivo indica che i dati di origine erano presenti, la stringa è stata copiata senza troncamento e il buffer di destinazione risultante viene terminato con null.
STATUS_BUFFER_OVERFLOW	Questo stato di avviso indica che l'operazione di copia non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Il buffer di destinazione contiene una versione troncata della stringa copiata.
STATUS_INVALID_PARAMETER	Questo stato di errore indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente. La funzione restituisce il valore STATUS_INVALID_PARAMETER quando: Il valore in cchDest è maggiore della dimensione massima del buffer. Il buffer di destinazione era già pieno. Era presente un puntatore NULL . La lunghezza del buffer di destinazione era zero, ma era presente una stringa di origine di lunghezza diversa da zero.

Codice restituito

Descrizione

STATUS_SUCCESS

Questo stato di esito positivo indica che i dati di origine erano presenti, la stringa è stata copiata senza troncamento e il buffer di destinazione risultante viene terminato con null.

STATUS_BUFFER_OVERFLOW

Questo stato di avviso indica che l'operazione di copia non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Il buffer di destinazione contiene una versione troncata della stringa copiata.

STATUS_INVALID_PARAMETER

Questo stato di errore indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente.

La funzione restituisce il valore STATUS_INVALID_PARAMETER quando:

Il valore in cchDest è maggiore della dimensione massima del buffer.
Il buffer di destinazione era già pieno.
Era presente un puntatore NULL .
La lunghezza del buffer di destinazione era zero, ma era presente una stringa di origine di lunghezza diversa da zero.

Commenti

È consigliabile usare RtlStringCchCopyNW e RtlStringCchCopyNA anziché strncpy.

Le funzioni copiano un determinato numero di caratteri da una stringa di origine. RtlStringCchCopyNW e RtlStringCchCopyNA ricevono le dimensioni, in caratteri, del buffer di destinazione per garantire che le funzioni non vengano scritte oltre la fine del buffer.

Si noti che queste funzioni si comportano in modo diverso rispetto a strncpy . Se cchSrc è maggiore del numero di caratteri in pszSrc, RtlStringCchCopyNW e RtlStringCchCopyNA, a differenza di strncpy, non continuare a riempire pszDest con caratteri Null fino a quando non vengono copiati i caratteri cchSrc .

Usare RtlStringCchCopyNW per gestire stringhe Unicode e RtlStringCchCopyNA per gestire le stringhe ANSI. Il modulo usato dipende dai dati, come illustrato nella tabella seguente.

Dati di tipo stringa	Valore letterale stringa	Funzione
WCHAR	L"string"	RtlStringCchCopyNW
char	"stringa"	RtlStringCchCopyNA

Se pszSrc e pszDest puntano a stringhe sovrapposte, il comportamento della funzione non è definito.

Né pszSrc né pszDest possono essere NULL. Se è necessario gestire i valori del puntatore di stringa NULL , usare RtlStringCchCopyNEx.

Per altre informazioni sulle funzioni di stringa sicura, vedere Using Safe String Functions.For more information about the safe string functions, see Using Safe String Functions.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Windows XP con Service Pack 1 (SP1) e versioni successive di Windows.
Piattaforma di destinazione	Desktop
Intestazione	ntstrsafe.h (include Ntstrsafe.h)
Libreria	Ntstrsafe.lib
IRQL	Se le stringhe modificate sono sempre residenti in memoria, in caso contrario PASSIVE_LEVEL

Vedi anche

RtlStringCbCopyN

RtlStringCchCopy

RtlStringCchCopyNEx

Condividi tramite