Funzione StringCchPrintfW (strsafe.h)

Articolo
11/20/2024

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.

StringCchPrintf è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCchPrintfW(
  [out] STRSAFE_LPWSTR  pszDest,
  [in]  size_t          cchDest,
  [in]  STRSAFE_LPCWSTR 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.

[in] pszFormat

Tipo: LPCTSTR

Stringa di formato. Questa stringa deve essere con terminazione Null. Per altre informazioni, vedere Format Specification Syntax.

...

Argomenti da inserire nella stringa pszFormat.

Valore restituito

Tipo: HRESULT

Questa funzione può restituire uno dei valori seguenti. Per testare il valore restituito di questa funzione, è consigliabile utilizzare il SUCCEEDED e MACRO FAILED.

Codice restituito	Descrizione
S_OK	Spazio sufficiente per copiare il risultato in pszDest senza troncamento e il buffer viene terminato con null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cchDest è 0 o maggiore di STRSAFE_MAX_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione troncata con terminazione Null del risultato previsto. In 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 sostituite.

Osservazioni

Rispetto alle funzioni sostituite, StringCchPrintf 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. StringCchPrintf termina sempre un buffer di destinazione diverso da zero.

Il comportamento non è definito se le stringhe a cui puntano pszDest, pszFormato si sovrappongono a qualsiasi stringa di argomento.

Né pszFormat né pszDest devono essere NULL. Vedere StringCchPrintfEx se è necessaria la gestione dei valori del puntatore di stringa Null.

StringCchPrintf può essere usato nel formato generico o nei moduli più specifici. Il tipo di dati della stringa determina la forma di questa funzione da usare.

Tipo di dati String	Valore letterale stringa	Funzione
char	"string"	stringCchPrintfA
TCHAR	TEXT("string")	StringCchPrintf
WCHAR	L"string"	StringCchPrintfW

Esempi

Nell'esempio seguente viene illustrato un semplice utilizzo di StringCchPrintf, usando quattro argomenti.

TCHAR pszDest[30]; 
size_t cchDest = 30;

LPCTSTR pszFormat = TEXT("%s %d + %d = %d.");
TCHAR* pszTxt = TEXT("The answer is");

HRESULT hr = StringCchPrintf(pszDest, cchDest, pszFormat, pszTxt, 1, 2, 3);

// The resultant string at pszDest is "The answer is 1 + 2 = 3."

Nota

L'intestazione strsafe.h definisce StringCchPrintf 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 non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
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	Finestre
intestazione	strsafe.h

Vedere anche

riferimento

StringCbPrintf

StringCchPrintfEx

StringCchVPrintf

Condividi tramite