Funzione RtlStringCbVPrintfW (ntstrsafe.h)

Le funzioni RtlStringCbVPrintfW e RtlStringCbVPrintfA creano una stringa di testo con conteggio byte, con formattazione basata sulle informazioni di formattazione fornite.

Sintassi

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

Parametri

[out] pszDest

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

[in] cbDest

Dimensioni del buffer di destinazione, in byte. Il buffer deve essere abbastanza grande per contenere la stringa formattata e il carattere null terminante.

Per le stringhe Unicode, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Per le stringhe ANSI, il numero massimo di byte è NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszFormat

Puntatore a una stringa di testo con terminazione null contenente direttive di formattazione in stile printf.

[in] argList

Elenco di argomenti va_list tipizzato. 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 Uso 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 viene terminato con 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 di STATUS_INVALID_PARAMETER quando: Il valore in cbDest è maggiore della dimensione massima del buffer. Il buffer di destinazione era già pieno. È stato presente un puntatore NULL . La lunghezza del buffer di destinazione era zero, ma era presente una stringa di origine di lunghezza non zero.

Commenti

RtlStringCbVPrintfW e RtlStringCbVPrintfA devono essere usati anziché le funzioni seguenti:

• vsprintf
• vswprintf
• _vsnprintf
• _vsnwprintf

Tutte queste funzioni accettano una stringa di formato, insieme a un set di argomenti in un elenco di argomenti va_list tipizzato e restituisce una stringa formattata. Le dimensioni, in byte, del buffer di destinazione vengono fornite a RtlStringCbVPrintfW e RtlStringCbVPrintfA per assicurarsi di non scrivere oltre la fine del buffer.

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

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

 

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 devono essere NULL. Se è necessario gestire i valori del puntatore stringa NULL , usare RtlStringCbVPrintfEx.

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	PASSIVE_LEVEL

Vedi anche

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf