StringCchPrintf_lExA, fonction (strsafe.h)

Article
03/02/2024

Écrit les données mises en forme dans la chaîne spécifiée. La taille de la mémoire tampon de destination est fournie à la fonction pour s’assurer qu’elle n’écrit pas après la fin de cette mémoire tampon.

StringCchPrintf_lEx est similaire à StringCchPrintfEx , mais inclut un paramètre pour les informations de paramètres régionaux.

Syntaxe

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

Paramètres

[out] pszDest

Mémoire tampon de destination, qui reçoit la chaîne mise en forme terminée par null créée à partir de pszFormat et de ses arguments.

[in] cchDest

Taille de la mémoire tampon de destination, en caractères. Cette valeur doit être suffisamment grande pour prendre en charge la chaîne mise en forme finale plus 1 pour tenir compte du caractère null de fin. Le nombre maximal de caractères autorisé est STRSAFE_MAX_CCH.

[out] ppszDestEnd

Adresse d’un pointeur vers la fin de pszDest. Si ppszDestEnd n’a pas la valeur NULL et que des données sont copiées dans la mémoire tampon de destination, cela pointe vers le caractère null de fin à la fin de la chaîne.

[out, optional] pcchRemaining

Nombre de caractères inutilisés dans pszDest, y compris le caractère null de fin. Si pcchRemaining a la valeur NULL, le nombre n’est pas conservé ou retourné.

[in] dwFlags

Une ou plusieurs des valeurs suivantes.

Valeur	Signification
STRSAFE_FILL_BEHIND_NULL 0x00000200	Si la fonction réussit, l’octet faible de dwFlags (0) est utilisé pour remplir la partie non initialisée de pszDest après le caractère null de fin.
STRSAFE_IGNORE_NULLS 0x00000100	Traitez les pointeurs de chaîne NULL comme des chaînes vides (TEXT(« »)).
STRSAFE_FILL_ON_FAILURE 0x00000400	En cas d’échec de la fonction, l’octet faible de dwFlags (0) est utilisé pour remplir la mémoire tampon pszDest entière, et la mémoire tampon est terminée par la valeur Null. En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée retournée est remplacée.
STRSAFE_NULL_ON_FAILURE 0x00000800	Si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(« »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.
STRSAFE_NO_TRUNCATION 0x00001000	Comme dans le cas de STRSAFE_NULL_ON_FAILURE, si la fonction échoue, pszDest est défini sur une chaîne vide (TEXT(« »)). En cas d’échec STRSAFE_E_INSUFFICIENT_BUFFER , toute chaîne tronquée est remplacée.

[in] pszFormat

Chaîne de format. Cette chaîne doit être terminée par null. Pour plus d’informations, consultez Syntaxe de spécification de format.

[in] locale

Objet de paramètres régionaux. Pour plus d’informations, consultez _create_locale.

...

Arguments à insérer dans la chaîne pszFormat .

Valeur retournée

Cette fonction peut retourner l’une des valeurs suivantes. Il est fortement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.

Code de retour	Description
S_OK	Il y avait suffisamment d’espace pour que le résultat soit copié dans pszDest sans troncation et la mémoire tampon est terminée par la valeur Null.
STRSAFE_E_INVALID_PARAMETER	La valeur dans cchDest est 0 ou supérieure à STRSAFE_MAX_CCH, ou la mémoire tampon de destination est déjà pleine.
STRSAFE_E_INSUFFICIENT_BUFFER	L’opération de copie a échoué en raison d’un espace de mémoire tampon insuffisant. Selon la valeur de dwFlags, la mémoire tampon de destination peut contenir une version tronquée et terminée par un caractère Null du résultat prévu. Dans les situations où la troncation est acceptable, cela ne peut pas nécessairement être considéré comme une condition de défaillance.

Remarques

Le comportement n’est pas défini si les chaînes pointées par pszDest, pszFormat ou des chaînes d’arguments se chevauchent.

Ni pszFormat ni pszDest ne doivent avoir la valeur NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié, auquel cas les deux peuvent être NULL. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si les valeurs NULL sont ignorées.

Pour utiliser cette fonction, vous devez définir la macro suivante dans votre fichier d’en-tête, avant d’inclure StrSafe.h.

#define STRSAFE_LOCALE_FUNCTIONS

Notes

L’en-tête strsafe.h définit StringCchPrintf_lEx en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau \| applications UWP]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau \| applications UWP]
Plateforme cible	Windows
En-tête	strsafe.h

Partager via