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

Sintassi

STRSAFEAPI StringCchPrintf_lExA(
  [out]           STRSAFE_LPSTR                                  pszDest,
  [in]            size_t                                         cchDest,
  [out]           STRSAFE_LPSTR                                  *ppszDestEnd,
  [out, optional] size_t                                         *pcchRemaining,
  [in]            DWORD                                          dwFlags,
  [in]            _Printf_format_string_params_(2)STRSAFE_LPCSTR pszFormat,
  [in]            _locale_t                                      locale,
                  ...                                            
);

Parametri

[out] pszDest

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

[in] cchDest

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

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

Numero di caratteri inutilizzati in pszDest, incluso il carattere Null di terminazione. Se pcchRemaining è 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, viene usato il byte basso di dwFlags (0) per riempire la parte non inizializzata di pszDest dopo il carattere Null di terminazione.
STRSAFE_IGNORE_NULLS 0x00000100	Considerare puntatori a stringhe null come stringhe vuote (TEXT("")).
STRSAFE_FILL_ON_FAILURE 0x00000400	Se la funzione ha esito negativo, viene usato il byte basso di dwFlags (0) per riempire l'intero buffer pszDest e il buffer viene terminato con null. In caso di errore STRSAFE_E_INSUFFICIENT_BUFFER, qualsiasi stringa troncata restituita viene sovrascritta.
STRSAFE_NULL_ON_FAILURE 0x00000800	Se la funzione non riesce, pszDest è impostata su una stringa vuota (TEXT("")). In caso di errore 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 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 Format Specification Syntax.

[in] locale

Oggetto impostazioni locali. Per altre informazioni, vedere _create_locale.

...

Argomenti da inserire nella stringa pszFormat.

Valore restituito

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_CCHoppure 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. In situazioni in cui il troncamento è accettabile, questo potrebbe non essere necessariamente considerato come una condizione di errore.

Osservazioni

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.

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 StringCchPrintf_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 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 Vista [app desktop \| App UWP]
server minimo supportato	Windows Server 2008 [app desktop \| App UWP]
piattaforma di destinazione	Finestre
intestazione	strsafe.h

Condividi tramite