StringCchGetsA-Funktion (strsafe.h)

Artikel
08/26/2023

Ruft eine Textzeile von stdin bis einschließlich des Zeilenumbruchzeichens ("\n") ab. Die Textzeile wird in den Zielpuffer kopiert, und das Zeilenumbruchzeichen wird durch ein NULL-Zeichen ersetzt. Die Größe des Zielpuffers wird für die Funktion bereitgestellt, um sicherzustellen, dass sie nicht über das Ende dieses Puffers schreibt.

Hinweis Diese Funktion kann nur inline verwendet werden.

StringCchGets ist ein Ersatz für die folgenden Funktionen:

ruft, _getws, _getts

StringCchGets ist kein Ersatz für fgets. Dadurch werden Zeilenumbruchzeichen nicht durch ein endendes NULL-Zeichen ersetzt.

Syntax

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

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die kopierten Zeichen empfängt.

[in] cchDest

Typ: size_t

Die Größe des Zielpuffers in Zeichen. Dieser Wert muss mindestens 2 sein, damit die Funktion erfolgreich ist. Die maximal zulässige Anzahl von Zeichen, einschließlich des beendenden NULL-Zeichens, ist STRSAFE_MAX_CCH. Wenn cchDest zu klein ist, um die vollständige Textzeile aufzunehmen, werden die Daten abgeschnitten.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen der folgenden Werte zurückgeben. Es wird dringend empfohlen, die Makros SUCCEEDED und FAILED zu verwenden, um den Rückgabewert dieser Funktion zu testen.

Rückgabecode	BESCHREIBUNG
S_OK	Zeichen wurden aus stdin gelesen, wurden bei pszDest in den Puffer kopiert, und der Puffer war null-beendet.
STRSAFE_E_END_OF_FILE	Gibt einen Fehler oder eine Dateiendebedingung an. Verwenden Sie feof oder ferror , um zu bestimmen, welche aufgetreten ist.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cchDest ist größer als der maximal zulässige Wert.
STRSAFE_E_INSUFFICIENT_BUFFER	Der Wert in cchDest ist 1 oder weniger.

Beachten Sie, dass diese Funktion im Gegensatz zu den funktionen, die sie ersetzt, einen HRESULT-Wert zurückgibt.

Hinweise

StringCchGets bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist mit vielen Sicherheitsproblemen verbunden, die Pufferüberläufe umfassen. StringCchGets beendet immer null einen Zielpuffer mit ungleicher Länge.

Der Wert von pszDest sollte nicht NULL sein. Wenn Sie die Behandlung von NULL-Zeichenfolgenzeigerwerten benötigen, finden Sie unter StringCchGetsEx .

StringCchGets kann in seiner generischen Form oder in seinen spezifischeren Formen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten, wie in der folgenden Tabelle gezeigt.

String-Datentyp	Zeichenfolgenliterale	Funktion
char	„String“	StringCchGetsA
TCHAR	TEXT("string")	StringCchGets
WCHAR	L"Zeichenfolge"	StringCchGetsW

Hinweis

Der strsafe.h-Header definiert StringCchGets als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	strsafe.h

Weitere Informationen

Referenz

StringCbGets

StringCchGetsEx

Freigeben über