Condividi tramite

Funzione RtlUnicodeStringCbCopyStringNEx (ntstrsafe.h)

  • Articolo

La funzione RtlUnicodeStringCbCopyStringNEx copia una stringa in una struttura UNICODE_STRING limitando le dimensioni della stringa copiata.

Sintassi

NTSTRSAFEDDI RtlUnicodeStringCbCopyStringNEx(
  [out]           PUNICODE_STRING  DestinationString,
  [in]            NTSTRSAFE_PCWSTR pszSrc,
  [in]            size_t           cbToCopy,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags
);

Parametri

[out] DestinationString

Facoltativo. Puntatore a una struttura UNICODE_STRING che riceve la stringa copiata. La stringa a cui punta il parametro pszSrc (escluso null di terminazione) viene copiata nel buffer a cui punta la struttura UNICODE_STRING del parametro DestinationString. Il numero massimo di byte nella stringa è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). DestinationString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] pszSrc

facoltativo. Puntatore alla stringa da copiare. Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] cbToCopy

Numero di byte da copiare dall'origine alla destinazione.

[out, optional] RemainingString

facoltativo. Se il chiamante fornisce un puntatore non NULL a una struttura UNICODE_STRING , la funzione imposta il membro Buffer di questa struttura alla fine della stringa concatenata, imposta il membro Length della struttura su zero e imposta il membro MaximumLength della struttura sul numero di byte rimanenti nel buffer di destinazione. RemainingString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] dwFlags

Uno o più flag e, facoltativamente, un byte di riempimento. I flag sono definiti come segue:

Valore Significato
STRSAFE_FILL_BEHIND_NULL Se questo flag è impostato e la funzione ha esito positivo, il byte basso di dwFlags viene usato per riempire la parte del buffer di destinazione che segue l'ultimo carattere nella stringa.
STRSAFE_IGNORE_NULLS Se questo flag è impostato, il puntatore di origine o di destinazione o entrambi può essere NULL. RtlUnicodeStringCbCopyStringNEx tratta i puntatori del buffer di origine NULL come stringhe vuote (TEXT("")), che possono essere copiate. I puntatori del buffer di destinazione NULL non possono ricevere stringhe non dispendiose.
STRSAFE_FILL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, viene usato il byte basso di dwFlags per riempire l'intero buffer di destinazione. Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NULL_ON_FAILURE Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione è impostato su una stringa vuota (TEXT(""). Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NO_TRUNCATION

Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW:

  • Se STRSAFE_FILL_ON_FAILURE viene specificato anche, STRSAFE_NO_TRUNCATION riempie di conseguenza il buffer di destinazione.
  • In caso contrario, il contenuto del buffer di destinazione verrà impostato su una stringa vuota, anche se STRSAFE_NULL_ON_FAILURE non è impostato. STRSAFE_FILL_BEHIND_NULL viene ignorato.
STRSAFE_ZERO_LENGTH_ON_FAILURE Se questo flag è impostato e la funzione restituisce STATUS_BUFFER_OVERFLOW, la lunghezza della stringa di destinazione è impostata su zero byte.

Valore restituito

RtlUnicodeStringCbCopyStringNEx restituisce uno dei valori NTSTATUS seguenti.

Codice restituito Descrizione
STATUS_SUCCESS Questo stato di esito positivo indica che i dati di origine erano presenti e le stringhe sono state concatenate senza troncamento.
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. Se STRSAFE_NO_TRUNCATION è impostato in dwFlags, il buffer di destinazione non viene modificato. Se il flag non è impostato, 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 l'elenco seguente.

RtlUnicodeStringCbCopyStringNEx restituisce il valore STATUS_INVALID_PARAMETER quando si verifica uno dei seguenti:

  • Il contenuto di una struttura UNICODE_STRING non è valido.
  • Un flag non valido viene specificato in dwFlags.
  • Il buffer di destinazione è già pieno.
  • Un puntatore del buffer è NULL e il flag di STRSAFE_IGNORE_NULLS non è specificato in dwFlags.
  • Il puntatore del buffer di destinazione è NULL, ma la dimensione del buffer non è zero.
  • Il puntatore del buffer di destinazione è NULL o la relativa lunghezza è zero, ma è presente una stringa di origine di lunghezza non zero.
  • Il valore del parametro cbToCopy è maggiore di NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR).

Per informazioni su come testare i valori NTSTATUS, vedere Uso di valori NTSTATUS.

Commenti

La funzione RtlUnicodeStringCbCopyStringNEx usa le dimensioni del buffer di destinazione per assicurarsi che l'operazione di copia non venga scritta oltre la fine del buffer. Per impostazione predefinita, la funzione non termina la stringa risultante con un valore di carattere Null, ovvero con zero. Come opzione, il chiamante può usare il flag STRSAFE_FILL_BEHIND e un valore di byte di riempimento pari a zero per terminare una stringa risultante che non occupa l'intero buffer di destinazione.

RtlUnicodeStringCbCopyStringNEx aggiunge alla funzionalità della funzione RtlUnicodeStringCbCopyStringN restituisce una struttura UNICODE_STRING che identifica la fine della stringa di destinazione e il numero di byte lasciati inutilizzati in tale stringa. È possibile passare flag RtlUnicodeStringCbCopyStringNEx per un controllo aggiuntivo.

Se le stringhe di origine e di destinazione si sovrappongono, il comportamento della funzione non è definito.

I puntatori pszSrc e DestinationString non possono essere NULL a meno che il flag STRSAFE_IGNORE_NULLS sia impostato in dwFlags. Se STRSAFE_IGNORE_NULLS è impostato, uno o entrambi questi puntatori possono essere NULL. Se il puntatore DestinationString è NULL, il puntatore pszSrc deve essere NULL o puntare a una stringa vuota.

Per altre informazioni sulle funzioni stringa sicure, vedere Uso di funzioni stringa sicure.

Requisiti

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

Vedi anche