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

Sintassi

STRSAFEAPI StringCchPrintf_lW(
  [out] STRSAFE_LPWSTR                                  pszDest,
  [in]  size_t                                          cchDest,
  [in]  _Printf_format_string_params_(2)STRSAFE_LPCWSTR 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.

[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_CCH.
STRSAFE_E_INSUFFICIENT_BUFFER	L'operazione di copia non è riuscita a causa di spazio buffer insufficiente. Il buffer di destinazione contiene una versione troncata 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. Vedere StringCchPrintf_lEx se è necessaria la gestione dei valori del puntatore di stringa Null.

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