funzione StringCbVPrintf_lExW (strsafe.h)

Articolo
03/02/2024

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_lEx è simile a StringCbVPrintfEx , ma include un parametro per le informazioni sulle impostazioni locali.

Sintassi

STRSAFEAPI StringCbVPrintf_lExW(
  [out]           STRSAFE_LPWSTR                                  pszDest,
  [in]            size_t                                          cbDest,
  [out]           STRSAFE_LPWSTR                                  *ppszDestEnd,
  [out, optional] size_t                                          *pcbRemaining,
  [in]            DWORD                                           dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCWSTR pszFormat,
  [in]            _locale_t                                       locale,
  [in]            va_list                                         argList
);

Parametri

[out] pszDest

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

[in] cbDest

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).

[out] ppszDestEnd

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] pcbRemaining

Numero di byte inutilizzati in pszDest, inclusi quelli usati per il carattere Null di terminazione. Se pcbRemaining è NULL, il conteggio non viene mantenuto o restituito.

[in] dwFlags

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

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

[in] locale

Oggetto delle impostazioni locali. Per altre informazioni, vedere _create_locale.

[in] argList

Argomenti da inserire nella stringa pszFormat .

Valore restituito

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	È disponibile spazio sufficiente per copiare il risultato in pszDest senza troncamento e il buffer è con terminazione Null.
STRSAFE_E_INVALID_PARAMETER	Il valore in cbDest è 0 o maggiore di `STRSAFE_MAX_CCH * sizeof(TCHAR)`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.

Commenti

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 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.

Per usare questa funzione, è necessario definire la macro seguente nel file di intestazione, prima di includere StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Nota

L'intestazione strsafe.h definisce StringCbVPrintf_lEx 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 Vista [app desktop \| App UWP]
Server minimo supportato	Windows Server 2008 [app desktop \| App UWP]
Piattaforma di destinazione	Windows
Intestazione	strsafe.h

Condividi tramite