Condividi tramite

Funzione RtlStringCbCopyUnicodeStringEx (ntstrsafe.h)

  • Articolo

La funzione RtlStringCbCopyUnicodeStringEx copia il contenuto di una struttura UNICODE_STRING in una destinazione specificata.

Sintassi

NTSTRSAFEDDI RtlStringCbCopyUnicodeStringEx(
  [out]           NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [in]            PCUNICODE_STRING SourceString,
  [out]           NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags
);

Parametri

[out] pszDest

Facoltativo. Puntatore a un buffer che riceve la stringa copiata. Stringa a cui punta la struttura di UNICODE_STRING del parametro SourceString da copiare nel buffer in pszDest e terminata con un carattere Null. Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] cbDest

Dimensioni, in byte, del buffer di destinazione. Il buffer deve essere abbastanza grande per la stringa e il carattere null di terminazione. Il numero massimo di byte nel buffer è NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

[in] SourceString

facoltativo. Puntatore a una struttura UNICODE_STRING contenente la stringa da copiare. Il numero massimo di byte nella stringa è NTSTRSAFE_UNICODE_STRING_MAX_CCH * sizeof(WCHAR). Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[out] ppszDestEnd

facoltativo. Se il chiamante fornisce un puntatore di indirizzi non NULL , dopo il completamento dell'operazione di copia, la funzione carica tale indirizzo con un puntatore al terminatore null risultante del buffer di destinazione.

[out, optional] pcbRemaining

facoltativo. Se il chiamante fornisce un puntatore di indirizzi non NULL , la funzione carica l'indirizzo con il numero di byte inutilizzati che si trovano nel buffer a cui pszDest punta, inclusi i byte usati per il carattere null terminante.

[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, viene usato il byte basso di dwFlags per riempire la parte del buffer di destinazione che segue il carattere Null di terminazione.
STRSAFE_IGNORE_NULLS Se questo flag è impostato, il puntatore di origine o di destinazione o entrambi può essere NULL. RtlStringCbCopyUnicodeStringEx 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, il byte basso di dwFlags viene usato per riempire l'intero buffer di destinazione e il buffer viene terminato null. 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.

Valore restituito

RtlStringCbCopyUnicodeStringEx restituisce uno dei valori NTSTATUS seguenti.

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 valore 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. 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.

RtlStringCbCopyUnicodeStringEx restituisce il valore STATUS_INVALID_PARAMETER quando si verifica una delle operazioni seguenti:

  • Il contenuto della struttura UNICODE_STRING non è valido.
  • Un flag non valido viene specificato in dwFlags.
  • Il valore in cbDest è maggiore della dimensione massima del buffer.
  • Il buffer di destinazione (a cui pszDest punta) è già pieno.
  • Un puntatore del buffer è NULL e il flag di STRSAFE_IGNORE_NULLS non è specificato.
  • Il puntatore del buffer di destinazione è NULL, ma la dimensione del buffer non è zero.
  • Il puntatore del buffer di destinazione è NULL o la lunghezza è zero, ma è presente una stringa di origine di lunghezza non zero.

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

Commenti

La funzione RtlStringCbCopyUnicodeStringEx usa le dimensioni del buffer di destinazione (che il parametro cbDest specifica) per assicurarsi che l'operazione di copia non venga scritta oltre la fine del buffer.

RtlStringCbCopyUnicodeStringEx aggiunge alla funzionalità della funzione RtlStringCbCopyUnicodeStringString Restituisce un puntatore alla fine della stringa di destinazione e il numero di byte lasciati inutilizzati in tale stringa. È possibile passare i flag alla funzione per un controllo aggiuntivo.

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

I puntatori *SourceString *e pszDest non possono essere NULL a meno che il flag di STRSAFE_IGNORE_NULLS sia impostato in dwFlags. Se STRSAFE_IGNORE_NULLS è impostato, uno o entrambi questi puntatori possono essere NULL. Se il puntatore pszDest è NULL, il puntatore *SourceString *deve essere NULL o la struttura UNICODE_STRING deve descrivere una stringa vuota.

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

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 Qualsiasi se le stringhe modificate sono sempre residenti in memoria, in caso contrario PASSIVE_LEVEL

Vedi anche