Funzione RtlStringCbPrintfExW (ntstrsafe.h)

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

Sintassi

NTSTRSAFEDDI RtlStringCbPrintfExW(
  [out, optional] NTSTRSAFE_PWSTR  pszDest,
  [in]            size_t           cbDest,
  [out, optional] NTSTRSAFE_PWSTR  *ppszDestEnd,
  [out, optional] size_t           *pcbRemaining,
  [in]            DWORD            dwFlags,
  [in, optional]  NTSTRSAFE_PCWSTR pszFormat,
                  ...              
);

Parametri

[out, optional] 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. Il puntatore pszDest può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

[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).

Se pszDest è NULL, cbDest deve essere zero.

[out, optional] ppszDestEnd

Se il chiamante fornisce un puntatore di indirizzo non NULL , al termine dell'operazione, la funzione carica tale indirizzo con un puntatore al terminatore di stringa Null risultante del buffer di destinazione.

[out, optional] pcbRemaining

Se il chiamante fornisce un puntatore di indirizzo non NULL , la funzione carica l'indirizzo con il numero di byte inutilizzati presenti nel buffer a cui punta pszDest, inclusi i byte utilizzati per il carattere Null di terminazione.

[in] dwFlags

Uno o più flag e, facoltativamente, un byte di riempimento. I flag sono definiti come segue:

Valore	Significato
STRSAFE_FILL_BEHIND_NULL	Se impostato e la funzione ha esito positivo, il byte basso di dwFlags viene usato per riempire la parte del buffer di destinazione che segue il carattere null di terminazione.
STRSAFE_IGNORE_NULLS	Se impostato, pszDest o pszSrc o entrambi possono essere NULL. I puntatori pszSrcNULL vengono trattati come stringhe vuote (TEXT(""), che possono essere copiate. I puntatori pszDestNULL non possono ricevere stringhe non vuoti.
STRSAFE_FILL_ON_FAILURE	Se set e la funzione ha esito negativo, il byte basso di dwFlags viene usato per riempire l'intero buffer di destinazione e il buffer viene terminato null. Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NULL_ON_FAILURE	Se impostato e la funzione ha esito negativo, il buffer di destinazione viene impostato su una stringa vuota (TEXT("")). Questa operazione sovrascrive qualsiasi contenuto del buffer preesistente.
STRSAFE_NO_TRUNCATION	Se impostata e la funzione restituisce STATUS_BUFFER_OVERFLOW, il contenuto del buffer di destinazione non viene modificato.

[in, optional] pszFormat

Puntatore a una stringa di testo con terminazione Null che contiene direttive di formattazione in stile printf. Il puntatore pszFormat può essere NULL, ma solo se STRSAFE_IGNORE_NULLS è impostato in dwFlags.

...

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 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. 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 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: È stato specificato un flag non valido. Il valore in cbDest è maggiore della dimensione massima del buffer. Il buffer di destinazione era già pieno. È stato presente un puntatore NULL senza il flag di STRSAFE_IGNORE_NULLS. Il puntatore al buffer di destinazione era NULL, ma la dimensione del buffer non era zero. Il puntatore al buffer di destinazione era NULL o la lunghezza era zero, ma era presente una stringa di origine di lunghezza diversa da zero.

Commenti

È consigliabile usare RtlStringCbPrintfExW e RtlStringCbPrintfExA 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 RtlStringCbPrintfExW e RtlStringCbPrintfExA per assicurarsi che non vengano scritte oltre la fine del buffer.

RtlStringCbPrintfExW e RtlStringCbPrintfExA aggiungono alla funzionalità di RtlStringCbPrintf restituendo un puntatore alla fine della stringa di destinazione, nonché il numero di byte rimasti inutilizzati in tale stringa. I flag possono essere passati alla funzione per un controllo aggiuntivo.

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

 

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 a meno che non sia impostato il flag STRSAFE_IGNORE_NULLS, nel qual caso o entrambi possono essere NULL. Se pszDest è NULL, pszFormat deve essere NULL o puntare a una stringa vuota.

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 a partire da Windows XP con Service Pack 1 (SP1).
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

RtlStringCbVPrintfEx

RtlStringCchPrintf

RtlStringCchPrintfEx