Funzione StringCchPrintfExA (strsafe.h)

Articolo
03/15/2023

Scrive i dati formattati nella stringa specificata. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.

StringCchPrintfEx aggiunge alla funzionalità di StringCchPrintf restituendo un puntatore alla fine della stringa di destinazione, nonché il numero di caratteri rimasti inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

StringCchPrintfEx è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCchPrintfExA(
  [out]           STRSAFE_LPSTR  pszDest,
  [in]            size_t         cchDest,
  [out, optional] STRSAFE_LPSTR  *ppszDestEnd,
  [out, optional] size_t         *pcchRemaining,
  [in]            DWORD          dwFlags,
  [in]            STRSAFE_LPCSTR pszFormat,
                  ...            
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve la stringa formattata con terminazione Null creata da pszFormat e i relativi argomenti.

[in] cchDest

Tipo: size_t

Dimensioni del buffer di destinazione, in caratteri. Questo valore deve essere sufficientemente grande per contenere la stringa formattata finale più 1 per tenere conto del carattere Null di terminazione. Il numero massimo di caratteri consentiti è STRSAFE_MAX_CCH.

[out, optional] ppszDestEnd

Tipo: LPTSTR*

Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd è diverso da NULL e tutti i dati vengono copiati nel buffer di destinazione, punta al carattere Null di terminazione alla fine della stringa.

[out, optional] pcchRemaining

Tipo: size_t*

Numero di caratteri inutilizzati in pszDest, incluso il carattere Null di terminazione. Se pcchRemaining è NULL, il conteggio non viene mantenuto o restituito.

[in] dwFlags

Tipo: DWORD

Uno o più dei valori seguenti.

Valore	Significato
STRSAFE_FILL_BEHIND_NULL 0x00000200	Se la funzione ha esito positivo, il byte basso di dwFlags (0) viene usato per riempire la parte non inizializzata di pszDest dopo il carattere null di terminazione.
STRSAFE_IGNORE_NULLS 0x00000100	Considerare i puntatori di stringa NULL come stringhe vuote (TEXT("")).
STRSAFE_FILL_ON_FAILURE 0x00000400	Se la funzione ha esito negativo, il byte basso di dwFlags (0) viene usato per riempire l'intero buffer pszDest e il buffer è con terminazione Null. In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata restituita viene sovrascritta.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.
STRSAFE_NO_TRUNCATION 0x00001000	Come nel caso di STRSAFE_NULL_ON_FAILURE, se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.

[in] pszFormat

Tipo: LPCTSTR

Stringa di formato. Questa stringa deve essere con terminazione Null. Per altre informazioni, vedere Sintassi della specifica del formato.

...

Argomenti da inserire nella stringa pszFormat .

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. È consigliabile utilizzare le macro SUCCEEDED e FAILED per testare il valore restituito di questa funzione.

Codice restituito	Descrizione
S_OK	Spazio sufficiente per il risultato da copiare in pszDest senza troncamento e il buffer è con terminazione Null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cchDest è 0 o maggiore di STRSAFE_MAX_CCH oppure il buffer di destinazione è già pieno.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. A seconda del valore di dwFlags, il buffer di destinazione può contenere una versione troncata e con terminazione Null del risultato previsto. Nelle situazioni in cui il troncamento è accettabile, questo potrebbe non essere necessariamente considerato come una condizione di errore.

Si noti che questa funzione restituisce un valore HRESULT , a differenza delle funzioni che sostituisce.

Commenti

Rispetto alle funzioni che sostituisce, StringCchPrintfEx fornisce un'elaborazione aggiuntiva per la gestione corretta del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano sovraccarichi del buffer. StringCchPrintfEx termina sempre un buffer di destinazione diverso da zero.

Il comportamento non è definito se le stringhe a cui punta pszDest, pszFormat o qualsiasi stringa di argomento si sovrappone.

Né pszFormat né pszDest devono essere NULL a meno che non venga specificato il flag STRSAFE_IGNORE_NULLS , nel qual caso entrambi possono essere NULL. Tuttavia, è possibile che venga restituito un errore dovuto a spazio insufficiente anche se i valori NULL vengono ignorati.

StringCchPrintfEx può essere usato nel formato generico o nelle forme più specifiche. Il tipo di dati della stringa determina la forma di questa funzione da usare.

Tipo di dati String	Stringhe letterali	Funzione
char	"stringa"	StringCchPrintfExA
TCHAR	TEXT("string")	StringCchPrintfEx
WCHAR	L"string"	StringCchPrintfExW

Nota

L'intestazione strsafe.h definisce StringCchPrintfEx come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice che non è indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzioni.

Requisiti


Client minimo supportato	Windows XP con SP2 [app desktop \| App UWP]
Server minimo supportato	Windows Server 2003 con SP1 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	strsafe.h

Vedi anche

Riferimento

StringCbPrintfEx

StringCchPrintf

StringCchVPrintfEx

Condividi tramite