Fonction StringCbGetsW (strsafe.h)

Article
08/26/2023

Obtient une ligne de texte de stdin, jusqu’à et y compris le caractère de nouvelle ligne (« \n »). La ligne de texte est copiée dans la mémoire tampon de destination et le caractère newline est remplacé par un caractère null. La taille de la mémoire tampon de destination est fournie à la fonction pour garantir qu’elle n’écrit pas au-delà de la fin de cette mémoire tampon.

Note Cette fonction ne peut être utilisée qu’en ligne.

StringCbGets remplace les fonctions suivantes :

obtient, _getws, _getts

StringCbGets ne remplace pas fgets, qui ne remplace pas les caractères newline par un caractère null de fin.

Syntaxe

STRSAFEAPI StringCbGetsW(
  [out] STRSAFE_LPWSTR pszDest,
  [in]  size_t         cbDest
);

Paramètres

[out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui reçoit l’entrée.

[in] cbDest

Type : size_t

Taille de la mémoire tampon de destination, en octets. Cette valeur doit être supérieure à celle pour que sizeof(TCHAR) la fonction réussisse. Le nombre maximal d’octets autorisé est STRSAFE_MAX_CCH * sizeof(TCHAR). Si cbDest est trop petit pour contenir la ligne de texte complète, les données sont tronquées.

Valeur retournée

Type : HRESULT

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

Code de retour	Description
S_OK	Les données ont été lues à partir de stdin, ont été copiées dans la mémoire tampon au niveau pszDest et la mémoire tampon a été terminée par null.
STRSAFE_E_END_OF_FILE	Indique une erreur ou une condition de fin de fichier. Utilisez feof ou ferror pour déterminer lequel s’est produit.
STRSAFE_E_INVALID_PARAMETER	La valeur dans cbDest est supérieure à la valeur maximale autorisée.
STRSAFE_E_INSUFFICIENT_BUFFER	La valeur dans cbDest est `sizeof(TCHAR)` ou inférieure.

Notez que cette fonction retourne une valeur HRESULT , contrairement aux fonctions qu’elle remplace.

Remarques

StringCbGets fournit un traitement supplémentaire pour une gestion appropriée de la mémoire tampon dans votre code. Une gestion médiocre de la mémoire tampon est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCbGets met toujours fin à une mémoire tampon de destination de longueur différente de zéro.

La valeur de pszDest ne doit pas être NULL. Consultez StringCbGetsEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

StringCbGets peut être utilisé dans sa forme générique ou dans ses formes plus spécifiques. Le type de données de la chaîne détermine la forme de cette fonction que vous devez utiliser, comme indiqué dans le tableau suivant.

String, type de données	Littéral de chaîne	Fonction
char	"chaîne"	StringCbGetsA
TCHAR	TEXT(« string »)	StringCbGets
WCHAR	L"string »	StringCbGetsW

Notes

L’en-tête strsafe.h définit StringCbGets comme un 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. Le mélange 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 XP avec SP2 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2003 avec SP1 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	strsafe.h

Voir aussi

Référence

StringCbGetsEx

StringCchGets

Partager via