Funzione RtlUnicodeStringVPrintfEx (ntstrsafe.h)

Articolo
05/23/2024

La funzione RtlUnicodeStringVPrintfEx crea una stringa di testo, con formattazione basata sulle informazioni di formattazione fornite e archivia la stringa in una struttura UNICODE_STRING .

Sintassi

NTSTRSAFEDDI RtlUnicodeStringVPrintfEx(
  [out]           PUNICODE_STRING  DestinationString,
  [out, optional] PUNICODE_STRING  RemainingString,
  [in]            DWORD            dwFlags,
  [in]            NTSTRSAFE_PCWSTR pszFormat,
  [in]            va_list          argList
);

Parametri

[out] DestinationString

Facoltativo. Puntatore a una struttura UNICODE_STRING che riceve una stringa formattata. RtlUnicodeStringVPrintfEx crea questa stringa dalla stringa di formattazione fornita da pszFormat e dall'elenco degli argomenti della funzione. Il numero massimo di caratteri nella stringa è NTSTRSAFE_UNICODE_STRING_MAX_CCH. DestinationString può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[out, optional] RemainingString

facoltativo. Se il chiamante fornisce un puntatore non NULL a una struttura UNICODE_STRING , RtlUnicodeStringVPrintfE imposta il membro Buffer della struttura alla fine della stringa formattata, 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:

STRSAFE_FILL_BEHIND

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. RtlUnicodeStringVPrintfEx 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, il contenuto del buffer di destinazione non viene modificato.

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.

[in] pszFormat

Puntatore a una stringa di testo con terminazione null contenente direttive di formattazione in stile printf. Questo puntatore può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[in] argList

Elenco di argomenti va_list tipizzato. Gli argomenti di questo elenco di argomenti verranno interpretati dalla stringa di formattazione fornita da pszFormat .

Valore restituito

RtlUnicodeStringVPrintfEx 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 il paragrafo seguente.

RtlUnicodeStringVPrintfEx restituisce il valore di STATUS_INVALID_PARAMETER quando si verifica una delle operazioni 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.

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

Commenti

La funzione RtlUnicodeStringVPrintfEx usa le dimensioni del buffer di destinazione per assicurarsi che l'operazione di formattazione della stringa 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.

RtlUnicodeStringVPrintfEx aggiunge alla funzionalità della funzione RtlUnicodeStringVPrintf restituendo 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 a RtlUnicodeStringVPrintfEx per un controllo aggiuntivo.

Se la stringa di formato e la stringa di destinazione si sovrappongono, il comportamento della funzione non è definito.

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

Per altre informazioni sugli elenchi di argomenti va_list tipizzato, vedere la documentazione di Microsoft Windows SDK.

Per altre informazioni sulle funzioni di stringa sicura, vedere Uso di funzioni stringhe 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