Funzione RtlStringCbCopyNW (ntstrsafe.h)

Articolo
08/07/2023

Le funzioni RtlStringCbCopyNW e RtlStringCbCopyNA copiano una stringa con conteggio byte in un buffer limitando al tempo stesso le dimensioni della stringa copiata.

Sintassi

NTSTRSAFEDDI RtlStringCbCopyNW(
  [out] NTSTRSAFE_PWSTR pszDest,
  [in]  size_t          cbDest,
  [in]  STRSAFE_PCNZWCH pszSrc,
        size_t          cbToCopy
);

Parametri

[out] pszDest

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

[in] cbDest

Dimensione, in byte, del buffer di destinazione. Il buffer deve essere sufficientemente grande sia per la stringa che per il carattere null di terminazione.

Per le stringhe Unicode, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Per le stringhe ANSI, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszSrc

Puntatore a una stringa con terminazione Null fornita dal chiamante.

cbToCopy

Numero massimo di byte da copiare da pszSrc a 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 cbDest è 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 cbDest è 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 RtlStringCbCopyNW e RtlStringCbCopyNA anziché strncpy. Tuttavia, queste funzioni differiscono nel comportamento. Se cbSrc è maggiore del numero di byte in pszSrc, le funzioni RtlStringCbCopyN , a differenza di strncpy, non riempiono pszDest con caratteri Null finché non vengono copiati i byte cbSrc .

RtlStringCbCopyN copia un determinato numero di byte da una stringa di origine. Le dimensioni, in byte, del buffer di destinazione vengono fornite alla funzione per garantire che RtlStringCbCopyN non scriva oltre la fine di questo buffer.

Usare RtlStringCbCopyNW per gestire stringhe Unicode e RtlStringCbCopyNA 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"	RtlStringCbCopyNW
char	"stringa"	RtlStringCbCopyNA

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 , vedere RtlStringCbCopyNEx.

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

RtlStringCbCopy

RtlStringCbCopyNEx

RtlStringCchCopyN

Condividi tramite