Funzione RtlStringCchVPrintfW (ntstrsafe.h)

Articolo
05/03/2024

Le funzioni RtlStringCchVPrintfW e RtlStringCchVPrintfA creano una stringa di testo con conteggio dei caratteri, con formattazione basata sulle informazioni di formattazione fornite.

Sintassi

NTSTRSAFEDDI RtlStringCchVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cchDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

Parametri

[out] pszDest

Puntatore a un buffer fornito dal chiamante che riceve una stringa formattata con terminazione Null. La funzione crea questa stringa sia dalla stringa di formattazione fornita da pszFormat che dagli argomenti forniti da argList.

[in] cchDest

Dimensioni del buffer di destinazione, in caratteri. Il buffer deve essere sufficientemente grande da contenere la stringa formattata più il carattere Null di terminazione. Il numero massimo di caratteri consentiti è NTSTRSAFE_MAX_CCH.

[in] pszFormat

Puntatore a una stringa di testo con terminazione Null che contiene direttive di formattazione in stile printf.

[in] argList

Elenco di argomenti tipizzato va_list. Gli argomenti contenuti nell'elenco di argomenti verranno interpretati usando la stringa di formattazione fornita da pszFormat.

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 di output è stata creata senza troncamento e il buffer di destinazione risultante è con terminazione Null.
STATUS_BUFFER_OVERFLOW	Questo stato di avviso indica che l'operazione non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Il buffer di destinazione contiene una versione troncata della stringa creata.
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 cchDest è 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 di output è stata creata senza troncamento e il buffer di destinazione risultante è con terminazione Null.

STATUS_BUFFER_OVERFLOW

Questo stato di avviso indica che l'operazione non è stata completata a causa di spazio insufficiente nel buffer di destinazione. Il buffer di destinazione contiene una versione troncata della stringa creata.

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 cchDest è 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 RtlStringCchVPrintfW e RtlStringCchVPrintfA anziché le funzioni seguenti:

vsprintf
vswprintf
_vsnprintf
_vsnwprintf

Tutte queste funzioni accettano una stringa di formato e i relativi argomenti, forniti come elenco di argomenti tipizzato va_list, e restituiscono una stringa formattata. RtlStringCchVPrintfW e RtlStringCchVPrintfA ricevono le dimensioni, in caratteri, del buffer di destinazione per garantire che le funzioni non vengano scritte oltre la fine del buffer.

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

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

Se pszDest e pszFormat puntano a stringhe sovrapposte o se si sovrappongono stringhe di argomenti, il comportamento della funzione non è definito.

Né pszFormat né pszDest possono essere NULL. Se è necessario gestire i valori del puntatore di stringa NULL , usare RtlStringCchVPrintfEx.

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

RtlStringCbVPrintf

RtlStringCchPrintf

RtlStringCchVPrintfEx

Condividi tramite