Funzione RtlUnicodeStringVPrintfEx (ntstrsafe.h)

Articolo
02/07/2025

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

Opzionale. Puntatore a una struttura UNICODE_STRING che riceve una stringa formattata. RtlUnicodeStringVPrintfEx crea questa stringa dalla stringa di formattazione che pszFormat fornisce e dall'elenco di 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

Opzionale. Se il chiamante fornisce un puntatore null 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 puntatori null buffer di origine come stringhe vuote (TEXT("")), che possono essere copiate. i puntatori del buffer di destinazione null non possono ricevere stringhe non vuoti.

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 preesistente del buffer.

STRSAFE_NULL_ON_FAILURE

Se questo flag è impostato e la funzione ha esito negativo, il buffer di destinazione viene impostato su una stringa vuota (TEXT("")). Questa operazione sovrascrive qualsiasi contenuto preesistente del buffer.

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 viene impostata su zero byte.

[in] pszFormat

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

[in] argList

Elenco di argomenti va_listtipizzato. Gli argomenti in questo elenco di argomenti verranno interpretati dalla stringa di formattazione che pszFormat forniti.

Valore restituito

RtlUnicodeStringVPrintfEx restituisce uno dei valori NTSTATUS seguenti.

Codice restituito	Descrizione
STATUS_SUCCESS	Questo esito positivo stato indica che i dati di origine erano presenti e le stringhe sono state concatenate senza troncamento.
STATUS_BUFFER_OVERFLOW	Questo avviso stato 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 errore stato indica che la funzione ha ricevuto un parametro di input non valido. Per altre informazioni, vedere il paragrafo seguente.

RtlUnicodeStringVPrintfEx restituisce il valore STATUS_INVALID_PARAMETER quando si verifica una delle condizioni seguenti:

Il contenuto di una struttura di UNICODE_STRING non è valido.
Un flag non valido viene specificato in dwFlags.
Il buffer di destinazione è già pieno.
Un puntatore al 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 è NULLo la sua lunghezza è zero, ma è presente una stringa di origine di lunghezza diversa da zero.

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

Osservazioni

La funzione RtlUnicodeStringVPrintfEx usa le dimensioni del buffer di destinazione per assicurarsi che l'operazione di formattazione della stringa non scriva oltre la fine del buffer. Per impostazione predefinita, la funzione non terminare 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 null 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 rimasti 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 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_listtipizzato, vedere la documentazione di Microsoft Windows SDK.

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.

Fabbisogno

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, altrimenti PASSIVE_LEVEL