StringCbGetsExA, 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.

StringCbGetsEx ajoute à la fonctionnalité de StringCbGets en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre d’octets inutilisés dans cette chaîne. Des indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

StringCbGetsEx remplace les fonctions suivantes :

obtient, _getws, _getts

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

Syntaxe

STRSAFEAPI StringCbGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cbDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcbRemaining,
  [in]            DWORD         dwFlags
);

Paramètres

[out] pszDest

Type : LPTSTR

Mémoire tampon de destination, qui doit recevoir l’entrée.

[in] cbDest

Type : size_t

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

[out, optional] ppszDestEnd

Type : LPTSTR*

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] pcbRemaining

Type : size_t*

Nombre d’octets inutilisés dans pszDest, y compris ceux utilisés pour le caractère null de fin. Si pcbRemaining a la valeur NULL, le nombre n’est pas conservé ou retourné.

[in] dwFlags

Type : DWORD

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(« »)). Cet indicateur est utile pour émuler des fonctions telles que lstrcpy.
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.

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 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 ou un indicateur non valide a été passé.
STRSAFE_E_INSUFFICIENT_BUFFER	La valeur dans cbDest est 1 ou moins.

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

Remarques

StringCbGetsEx 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. StringCbGetsEx termine toujours une mémoire tampon de destination de longueur différente de zéro.

La valeur de pszDest ne doit pas être NULL , sauf si l’indicateur STRSAFE_IGNORE_NULLS est spécifié. Toutefois, une erreur due à un espace insuffisant peut toujours être retournée même si les valeurs NULL sont ignorées.

StringCbGetsEx 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"	StringCbGetsExA
TCHAR	TEXT(« string »)	StringCbGetsEx
WCHAR	L"string »	StringCbGetsExW

Notes

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

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

StringCbGets

StringCchGetsEx

Partager via