Funzione StringCbVPrintfW (strsafe.h)
Scrive i dati formattati nella stringa specificata usando un puntatore a un elenco di argomenti. Le dimensioni del buffer di destinazione vengono fornite alla funzione per assicurarsi che non venga scritto oltre la fine del buffer.
StringCbVPrintf è una sostituzione delle funzioni seguenti:
Sintassi
STRSAFEAPI StringCbVPrintfW(
[out] STRSAFE_LPWSTR pszDest,
[in] size_t cbDest,
[in] STRSAFE_LPCWSTR pszFormat,
[in] va_list argList
);
Parametri
[out] pszDest
Tipo: LPTSTR
Buffer di destinazione, che riceve la stringa formattata con terminazione Null creata da pszFormat e argList.
[in] cbDest
Tipo: size_t
Dimensioni del buffer di destinazione, in byte. Questo valore deve essere sufficientemente grande per contenere la stringa formattata finale più il carattere null di terminazione. Il numero massimo di byte consentiti è STRSAFE_MAX_CCH * sizeof(TCHAR)
.
[in] pszFormat
Tipo: LPCTSTR
Stringa di formato. Questa stringa deve essere con terminazione Null. Per altre informazioni, vedere Sintassi della specifica del formato.
[in] argList
Tipo: va_list
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 |
---|---|
|
Spazio sufficiente per il risultato da copiare in pszDest senza troncamento e il buffer è con terminazione Null. |
|
Il valore in cbDest è 0 o maggiore di STRSAFE_MAX_CCH * sizeof(TCHAR) .
|
|
L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione con terminazione Null troncata 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
StringCbVPrintf 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. StringCbVPrintf termina sempre un buffer di destinazione diverso da zero.
Per altre informazioni su va_lists, vedere le convenzioni definite in Stdarg.h.
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. Vedere StringCbVPrintfEx se è necessaria la gestione dei valori del puntatore di stringa Null.
StringCbVPrintf 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, come illustrato nella tabella seguente.
Tipo di dati String | Stringhe letterali | Funzione |
---|---|---|
char | "stringa" | StringCbVPrintfA |
TCHAR | TEXT("string") | StringCbVPrintf |
WCHAR | L"string" | StringCbVPrintfW |
Nota
L'intestazione strsafe.h definisce StringCbVPrintf 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
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 | Windows |
Intestazione | strsafe.h |
Vedi anche
Riferimento