Funzione RtlStringCbPrintfA (ntstrsafe.h)

Articolo
02/26/2024

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

Sintassi

NTSTRSAFEDDI RtlStringCbPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cbDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
        ...             
);

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 dall'elenco di argomenti della funzione.

[in] cbDest

Dimensioni del buffer di destinazione, in byte. Il buffer deve essere sufficientemente grande da contenere la stringa formattata più il carattere Null di terminazione.

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 che contiene direttive di formattazione in stile printf.

...

Elenco di argomenti interpretati dalla funzione in base alle direttive di formattazione contenute nella stringa 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 è 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 di output.
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 cbDest è 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 è 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 di output.

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 cbDest è 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 RtlStringCbPrintfW e RtlStringCbPrintfA anziché le funzioni seguenti:

sprintf
swprintf
_snprintf
_snwprintf

Tutte queste funzioni accettano una stringa di formato e un elenco di argomenti, li interpretano e creano una stringa formattata. Le dimensioni, in byte, del buffer di destinazione vengono fornite a RtlStringCbPrintfW e RtlStringCbPrintfA per assicurarsi che non vengano scritte oltre la fine del buffer.

Usare RtlStringCbPrintfW per gestire stringhe Unicode e RtlStringCbPrintfA per gestire stringhe ANSI. Il modulo usato dipende dai dati, come illustrato nella tabella seguente.

Dati di tipo stringa	Valore letterale stringa	Funzione
WCHAR	L"string"	RtlStringCbPrintfW
char	"stringa"	RtlStringCbPrintfA

Se pszDest e pszFormat puntano alla stringa sovrapposta 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 RtlStringCbPrintfEx.

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.

Esempio

L'esempio seguente illustra un uso di base di RtlStringCbPrintfW usando quattro argomenti.

int const arraysize = 30;
WCHAR pszDest[arraysize]; 
size_t cbDest = arraysize * sizeof(WCHAR);

LPCWSTR pszFormat = L"%s %d + %d = %d.";
WCHAR* pszTxt = L"The answer is";

NTSTATUS status = RtlStringCbPrintfW(pszDest, cbDest, pszFormat, pszTxt, 1, 2, 3);

La stringa risultante è "La risposta è 1 + 2 = 3". È contenuto nel buffer in pszDest.

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

RtlStringCbPrintfEx

RtlStringCbVPrintf

RtlStringCchPrintf