Partager via

Fonction StringCchGetsExA (strsafe.h)

  • Article

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.
 
StringCchGetsEx ajoute aux fonctionnalités de StringCchGets en retournant un pointeur vers la fin de la chaîne de destination, ainsi que le nombre de caractères inutilisés dans cette chaîne. Des indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

StringCchGetsEx remplace les fonctions suivantes :

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

Syntaxe

STRSAFEAPI StringCchGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cchDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcchRemaining,
  [in]            DWORD         dwFlags
);

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

Type : size_t*

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

Type : DWORD

Une ou plusieurs des valeurs suivantes.

Valeur Signification
STRSAFE_FILL_BEHIND_NULL
0x00000200
 Si la fonction réussit, l’octet inférieur 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
 Si la fonction échoue, 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 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 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 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 ou un indicateur non valide a été passé.
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

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

StringCchGetsEx 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" StringCchGetsExA
TCHAR TEXT(« string ») StringCchGetsEx
WCHAR L"string » StringCchGetsExW
 

Notes

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