Funzione StringCchPrintfExW (strsafe.h)
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 e il numero di caratteri rimasti inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.
StringCchPrintfEx sostituisce le funzioni seguenti:
Sintassi
STRSAFEAPI StringCchPrintfExW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cchDest,
[out, optional] STRSAFE_LPWSTR *ppszDestEnd,
[out, optional] size_t *pcchRemaining,
[in] DWORD dwFlags,
[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.
[out, optional] ppszDestEnd
Tipo: LPTSTR*
Indirizzo di un puntatore alla fine di pszDest. Se ppszDestEnd non è 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.
[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
Codice restituito | Descrizione |
---|---|
|
Spazio sufficiente per copiare il risultato in pszDest senza troncamento e il buffer viene terminato con null. |
|
Il valore in cchDest è 0 o maggiore di STRSAFE_MAX_CCHoppure il buffer di destinazione è già pieno. |
|
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. 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, StringCchPrintfEx fornisce un'elaborazione aggiuntiva per una corretta gestione 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 puntano pszDest, pszFormato si sovrappongono a qualsiasi stringa di argomento.
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 valori null vengono ignorati.
StringCchPrintfEx 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" | 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 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