RtlStringCbVPrintfW, fonction (ntstrsafe.h)

Les fonctions RtlStringCbVPrintfW et RtlStringCbVPrintfA créent une chaîne de texte comptée par octets, avec la mise en forme basée sur les informations de mise en forme fournies.

Syntaxe

NTSTRSAFEDDI RtlStringCbVPrintfW(
  [out] NTSTRSAFE_PWSTR  pszDest,
  [in]  size_t           cbDest,
  [in]  NTSTRSAFE_PCWSTR pszFormat,
  [in]  va_list          argList
);

Paramètres

[out] pszDest

Pointeur vers une mémoire tampon fournie par l’appelant qui reçoit une chaîne mise en forme et terminée par null. La fonction crée cette chaîne à partir de la chaîne de mise en forme fournie par pszFormat et les arguments fournis par argList.

[in] cbDest

Taille de la mémoire tampon de destination, en octets. La mémoire tampon doit être suffisamment grande pour contenir la chaîne mise en forme et le caractère null de fin.

Pour les chaînes Unicode, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(WCHAR).

Pour les chaînes ANSI, le nombre maximal d’octets est NTSTRSAFE_MAX_CCH * sizeof(char).

[in] pszFormat

Pointeur vers une chaîne de texte terminée par null qui contient des directives de mise en forme de style printf.

[in] argList

Liste d’arguments typées va_list. Les arguments contenus dans la liste d’arguments seront interprétés à l’aide de la chaîne de mise en forme fournie par pszFormat.

Valeur de retour

La fonction retourne l’une des valeurs NTSTATUS répertoriées dans le tableau suivant. Pour plus d’informations sur la façon de tester les valeurs NTSTATUS, consultez Utilisation des valeurs NTSTATUS.

Code de retour Description
STATUS_SUCCESS
Cet état de réussite signifie que les données sources étaient présentes, la chaîne de sortie a été créée sans troncation, et la mémoire tampon de destination résultante est terminée par null.
STATUS_BUFFER_OVERFLOW
Cet état d’avertissement signifie que l’opération n’a pas été terminée en raison d’un espace insuffisant dans la mémoire tampon de destination. La mémoire tampon de destination contient une version tronquée de la chaîne créée.
STATUS_INVALID_PARAMETER
Cet état d’erreur signifie que la fonction a reçu un paramètre d’entrée non valide. Pour plus d’informations, consultez le paragraphe suivant.

La fonction retourne la valeur STATUS_INVALID_PARAMETER lorsque :

  • La valeur en cbDest est supérieure à la taille maximale de la mémoire tampon.
  • La mémoire tampon de destination était déjà pleine.
  • Un pointeur NULL était présent.
  • La longueur de la mémoire tampon de destination était égale à zéro, mais une chaîne source de longueur non nulle était présente.

Remarques

RtlStringCbVPrintfW et RtlStringCbVPrintfA doivent être utilisés au lieu des fonctions suivantes :

  • vsprintf
  • vswprintf
  • _vsnprintf
  • _vsnwprintf
Toutes ces fonctions acceptent une chaîne de format, ainsi qu’un ensemble d’arguments dans une liste d’arguments typées va_list et retournent une chaîne mise en forme. La taille, en octets, de la mémoire tampon de destination est fournie à RtlStringCbVPrintfW et RtlStringCbVPrintfA pour s’assurer qu’elles n’écrivent pas au-delà de la fin de la mémoire tampon.

Pour plus d’informations sur les listes d’arguments typées va_list, consultez la documentation Microsoft Windows SDK.

Utilisez RtlStringCbVPrintfW pour gérer les chaînes Unicode et RtlStringCbVPrintfA pour gérer les chaînes ANSI. Le formulaire que vous utilisez dépend de vos données, comme indiqué dans le tableau suivant.

Type de données String Littéral de chaîne Fonction
WCHAR L"string » RtlStringCbVPrintfW
char "chaîne" RtlStringCbVPrintfA
 

Si pszDest et pszFormat pointent vers des chaînes qui se chevauchent ou si des chaînes d’argument se chevauchent, le comportement de la fonction n’est pas défini..

Ni pszFormat ni pszDest ne doit être NULL. Si vous devez gérer les valeurs de pointeur de chaîne NULL , utilisez RtlStringCbVPrintfEx.

Pour plus d’informations sur les fonctions de chaîne sécurisée, consultez Utilisation de fonctions de chaîne sécurisée.

Spécifications

   
Client minimal pris en charge Disponible à partir de Windows XP avec Service Pack 1 (SP1).
Plateforme cible Desktop (Expérience utilisateur)
En-tête ntstrsafe.h (inclure Ntstrsafe.h)
Bibliothèque Ntstrsafe.lib
IRQL PASSIVE_LEVEL

Voir aussi

RtlStringCbPrintf

RtlStringCbVPrintfEx

RtlStringCchVPrintf