StringCbGetsW-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.

StringCbGets ist ein Ersatz für die folgenden Funktionen:

gets, _getws, _getts

StringCbGets ist kein Ersatz für fgets, der Zeilenumbruchzeichen nicht durch ein abschließendes NULL-Zeichen ersetzt.

Syntax

STRSAFEAPI StringCbGetsW(
  [out] STRSAFE_LPWSTR pszDest,
  [in]  size_t         cbDest
);

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die Eingabe empfängt.

[in] cbDest

Typ: size_t

Die Größe des Zielpuffers in Bytes. Dieser Wert muss größer als sizeof(TCHAR) sein, damit die Funktion erfolgreich ist. Die maximal zulässige Anzahl von Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR). Wenn cbDest zu klein ist, um die vollständige Textzeile zu speichern, 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	Daten wurden aus stdin gelesen, um pszDest in den Puffer kopiert, und der Puffer wurde 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 cbDest ist größer als der maximal zulässige Wert.
STRSAFE_E_INSUFFICIENT_BUFFER	Der Wert in cbDest ist `sizeof(TCHAR)` oder kleiner.

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

Hinweise

StringCbGets bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferbehandlung in Ihrem Code. Eine schlechte Pufferbehandlung ist in viele Sicherheitsprobleme verwickelt, die Pufferüberläufe beinhalten. StringCbGets beendet einen Zielpuffer ungleich null.

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

StringCbGets kann in seiner generischen Form oder in 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“	StringCbGetsA
TCHAR	TEXT("string")	StringCbGets
WCHAR	L"string"	StringCbGetsW

Hinweis

Der strsafe.h-Header definiert StringCbGets 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 Code, der nicht Codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
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

StringCbGetsEx

StringCchGets

Share via