StringCchGetsExA, fonction (strsafe.h)

Article
11/20/2024

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 au-delà de la fin de cette mémoire tampon.

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

StringCchGetsEx ajoute aux fonctionnalités de StringCchGets en retournant un pointeur à la fin de la chaîne de destination, ainsi que le nombre de caractères laissés inutilisés dans cette chaîne. Les indicateurs peuvent également être passés à la fonction pour un contrôle supplémentaire.

StringCchGetsEx est un remplacement des fonctions suivantes :

obtient, _getws, _getts

StringCchGetsEx n’est pas un remplacement de fgets, qui ne remplace pas les caractères de nouvelle ligne 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 la ligne de texte complète, les données sont tronquées.

[out, optional] ppszDestEnd

Type : LPTSTR*

Adresse d’un pointeur à la fin de pszDest. Si ppszDestEnd n’est pas NULL et que toutes les 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 est 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 suivant le caractère null de fin.
STRSAFE_IGNORE_NULLS 0x00000100	Traitez null pointeurs de chaîne comme des chaînes vides (TEXT(« »)). Cet indicateur est utile pour simuler des fonctions telles que lstrcpy.
STRSAFE_FILL_ON_FAILURE 0x00000400	Si la fonction échoue, l’octet faible de dwFlags (0) est utilisé pour remplir l’intégralité de la mémoire tampon pszDest, 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 de retour

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.

Retourner le code	Description
S_OK	Les caractères ont été lus à partir de stdin, ont été copiés dans la mémoire tampon à 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 pour déterminer celui qui s’est produit.
STRSAFE_E_INVALID_PARAMETER	La valeur de cchDest est supérieure à la valeur maximale autorisée ou un indicateur non valide a été passé.
STRSAFE_E_INSUFFICIENT_BUFFER	La valeur de cchDest est de 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 la gestion appropriée des mémoires tampons dans votre code. Une mauvaise gestion des mémoires tampons est impliquée dans de nombreux problèmes de sécurité qui impliquent des dépassements de mémoire tampon. StringCchGetsEx toujours null met 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 valeurs NULL sont ignorées.

StringCchGetsEx peut être utilisé dans sa forme générique ou dans ses formulaires 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.

Type de données de chaîne	Littéral de chaîne	Fonction
char	« string »	StringCchGetsExA
TCHAR	TEXT(« string »)	StringCchGetsEx
WCHAR	L"string »	StringCchGetsExW

Note

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

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP avec SP2 [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2003 avec SP1 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	strsafe.h

Voir aussi

de référence

StringCbGetsEx

StringCchGets

Partager via