StringCchGetsA, fonction (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 de nouvelle ligne est remplacé par un caractère null. 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.

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

StringCchGets remplace les fonctions suivantes :

obtient, _getws, _getts

StringCchGets ne remplace pas fgets, qui ne remplace pas les caractères de ligne nouvelle par un caractère null de fin.

Syntaxe

STRSAFEAPI StringCchGetsA(
  [out] STRSAFE_LPSTR pszDest,
  [in]  size_t        cchDest
);

Paramètres

[out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui reçoit les caractères copiés.

[in] cchDest

Type : size_t

Taille de la mémoire tampon de destination, en caractères. Cette valeur doit être au moins égale à 2 pour que la fonction réussisse. Le nombre maximal de caractères autorisés, y compris le caractère null de fin, est STRSAFE_MAX_CCH. Si cchDest 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 fortement recommandé d’utiliser les macros SUCCEEDED et FAILED pour tester la valeur de retour de cette fonction.

Code de retour	Description
S_OK	Les caractères ont été lus à partir de stdin, ont été copiés 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 cchDest est supérieure à la valeur maximale autorisée.
STRSAFE_E_INSUFFICIENT_BUFFER	La valeur dans cchDest est 1 ou moins.

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

Remarques

StringCchGets 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. StringCchGets 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 StringCchGetsEx si vous avez besoin de gérer des valeurs de pointeur de chaîne null.

StringCchGets peut être utilisé sous 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"	StringCchGetsA
TCHAR	TEXT(« string »)	StringCchGets
WCHAR	L"string »	StringCchGetsW

Notes

L’en-tête strsafe.h définit StringCchGets comme 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


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

StringCbGets

StringCchGetsEx

Partager via