Funzione StringCchVPrintfExA (strsafe.h)

  • Articolo

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.

StringCchVPrintfEx aggiunge alla funzionalità di StringCchVPrintf restituendo un puntatore alla fine della stringa di destinazione e al numero di caratteri lasciati inutilizzati in tale stringa. I flag possono anche essere passati alla funzione per un controllo aggiuntivo.

StringCchVPrintfEx è una sostituzione delle funzioni seguenti:

Sintassi

STRSAFEAPI StringCchVPrintfExA(
  [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,
  [in]            va_list        argList
);

Parametri

[out] pszDest

Tipo: LPTSTR

Buffer di destinazione, che riceve la stringa con terminazione null formattata creata da pszFormat e argList.

[in] cchDest

Tipo: size_t

Dimensioni del buffer di destinazione, in caratteri. Questo valore deve essere sufficientemente grande per ospitare la stringa formattata finale più 1 per tenere conto del carattere Null terminante. 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, questo punta al carattere Null terminante alla fine della stringa.

[out, optional] pcchRemaining

Tipo: size_t*

Numero di caratteri inutilizzati in pszDest, incluso il carattere null terminante. 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 seguendo il carattere null terminante.
STRSAFE_IGNORE_NULLS
0x00000100
 Trattare 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 viene terminato con null. Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata restituita viene sovrascritto.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Se la funzione ha esito negativo, pszDest è impostata su una stringa vuota (TEXT("")). Nel caso di un 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("")). Nel caso di un errore di STRSAFE_E_INSUFFICIENT_BUFFER , qualsiasi stringa troncata viene sovrascritta.

[in] pszFormat

Tipo: LPCTSTR

Stringa di formato. Questa stringa deve essere terminata con 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 usare le macro SUCCESSED e FAILED per testare il valore restituito di questa funzione.

Codice restituito Descrizione
S_OK
 Il risultato è stato copiato in pszDest senza troncamento e il buffer è terminato 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 terminata 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.

Commenti

StringCchVPrintfEx offre un'elaborazione aggiuntiva per la gestione corretta del buffer nel codice. La gestione del buffer insufficiente è implicata in molti problemi di sicurezza che comportano l'overrun del buffer. StringCchVPrintfEx termina sempre null-termina un buffer di destinazione diverso da zero.

Per altre informazioni sulle va_lists, vedere le convenzioni definite in Stdarg.h.

Il comportamento non è definito se le stringhe puntate da pszDest, pszFormat o qualsiasi stringa di argomento si sovrappone.

Né pszFormat né pszDest devono essere NULL a meno che non sia specificato il flag di STRSAFE_IGNORE_NULLS, in cui entrambi possono essere NULL. Tuttavia, un errore dovuto a spazio insufficiente può essere restituito anche se i valori NULL vengono ignorati.

StringCchVPrintfEx 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, come illustrato nella tabella seguente.

Tipo di dati String Stringhe letterali Funzione
char "stringa" StringCchVPrintfExA
TCHAR TEXT("string") StringCchVPrintfEx
WCHAR L"string" StringCchVPrintfExW
 

Nota

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

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

StringCbVPrintfEx

StringCchPrintfEx

StringCchVPrintf