Funzione RtlStringCchPrintfA (ntstrsafe.h)

Articolo
08/07/2023

Le funzioni RtlStringCchPrintfW e RtlStringCchPrintfA creano una stringa di testo con conteggio caratteri, con formattazione basata su informazioni di formattazione fornite.

Sintassi

NTSTRSAFEDDI RtlStringCchPrintfA(
  [out] NTSTRSAFE_PSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  NTSTRSAFE_PCSTR pszFormat,
        ...             
);

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

[in] cchDest

Dimensioni del buffer di destinazione, in caratteri. Il buffer deve essere abbastanza grande per contenere la stringa formattata e il carattere null terminante. Il numero massimo di caratteri consentiti è NTSTRSAFE_MAX_CCH.

[in] pszFormat

Puntatore a una stringa di testo con terminazione null contenente 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 Uso 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 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 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 di STATUS_INVALID_PARAMETER quando: Il valore in cchDest è 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.

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 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 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 di STATUS_INVALID_PARAMETER quando:

Il valore in cchDest è 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

RtlStringCchPrintfW e RtlStringCchPrintfA devono essere usati anziché le funzioni seguenti:

sprintf
swprintf
_snprintf
_snwprintf

Tutte queste funzioni accettano una stringa di formato e un elenco di argomenti e restituiscono una stringa formattata. RtlStringCchPrintfW e RtlStringCchPrintfA accettano le dimensioni, in caratteri, del buffer di destinazione per garantire che le funzioni non scrivono oltre la fine del buffer.

Usare RtlStringCchPrintfW per gestire stringhe Unicode e RtlStringCchPrintfA per gestire le stringhe ANSI. Il modulo usato dipende dai dati.

Dati di tipo stringa	Valore letterale stringa	Funzione
WCHAR	L"string"	RtlStringCchPrintfW
char	"stringa"	RtlStringCchPrintfA

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 stringa NULL , usare RtlStringCchPrintfEx.

Esempio

Nell'esempio seguente viene illustrato un semplice uso di RtlStringCchPrintfW usando quattro argomenti.

WCHAR pszDest[30]; 
size_t cchDest = 30;

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

NTSTATUS status = 
    RtlStringCchPrintfW(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

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

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

Vedi anche

RtlStringCbPrintf

RtlStringCchPrintfEx

RtlStringCchVPrintf

Condividi tramite