StringCchGetsExW-Funktion (strsafe.h)

Artikel
11/20/2024

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 der Funktion bereitgestellt, um sicherzustellen, dass er nicht über das Ende dieses Puffers schreibt.

Hinweis Diese Funktion kann nur inline verwendet werden.

StringCchGetsEx fügt die Funktionalität von StringCchGets- hinzu, indem ein Zeiger an das Ende der Zielzeichenfolge sowie die Anzahl der zeichen zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet wurden. Flags können auch an die Funktion übergeben werden, um zusätzliche Steuerelemente zu erhalten.

StringCchGetsEx- ist ein Ersatz für die folgenden Funktionen:

erhält, _getws, _getts

StringCchGetsEx- ist kein Ersatz für fgets, wodurch keine Zeilenumbruchzeichen durch ein endendes Nullzeichen ersetzt werden.

Syntax

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

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 ausgeführt werden kann. Die maximale Anzahl zulässiger Zeichen, einschließlich des endierenden Nullzeichens, ist STRSAFE_MAX_CCH. Wenn cchDest- zu klein ist, um die vollständige Textzeile zu halten, werden die Daten abgeschnitten.

[out, optional] ppszDestEnd

Typ: LPTSTR*

Die Adresse eines Zeigers bis zum Ende pszDest. Wenn ppszDestEnd- nichtNULL- ist und alle Daten in den Zielpuffer kopiert werden, verweist dies auf das endende NULL-Zeichen am Ende der Zeichenfolge.

[out, optional] pcchRemaining

Typ: size_t*

Die Anzahl der nicht verwendeten Zeichen in pszDest, einschließlich des endenden Nullzeichens. Wenn pcchRemainingNULL-ist, wird die Anzahl nicht beibehalten oder zurückgegeben.

[in] dwFlags

Typ: DWORD-

Mindestens einer der folgenden Werte.

Wert	Bedeutung
STRSAFE_FILL_BEHIND_NULL 0x00000200	Wenn die Funktion erfolgreich ist, wird das niedrige Byte von dwFlags (0) verwendet, um den nicht initialisierten Teil pszDest nach dem endenden NULL-Zeichen auszufüllen.
STRSAFE_IGNORE_NULLS 0x00000100	Behandeln Sie NULL- Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("")). Dieses Kennzeichen ist nützlich, um Funktionen wie lstrcpyzu emulieren.
STRSAFE_FILL_ON_FAILURE 0x00000400	Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest Puffer auszufüllen, und der Puffer wird null beendet. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge, die zurückgegeben wird, überschrieben.
STRSAFE_NULL_ON_FAILURE 0x00000800	Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NO_TRUNCATION 0x00001000	Wenn die Funktion fehlschlägt, wird pszDest- wie bei STRSAFE_NULL_ON_FAILURE auf eine leere Zeichenfolge (TEXT("")) festgelegt. Bei einem STRSAFE_E_INSUFFICIENT_BUFFER Fehler wird jede abgeschnittene Zeichenfolge überschrieben.

Rückgabewert

Typ: HRESULT-

Diese Funktion kann einen der folgenden Werte zurückgeben. Es wird dringend empfohlen, die SUCCEEDED und FAILED Makros zum Testen des Rückgabewerts dieser Funktion zu verwenden.

Rückgabecode	Beschreibung
S_OK	Zeichen wurden aus stdin gelesen, in den Puffer bei pszDestkopiert, 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, welcher aufgetreten ist.
STRSAFE_E_INVALID_PARAMETER	Der Wert in cchDest- ist größer als der maximal zulässige Wert oder ein ungültiges Flag wurde übergeben.
STRSAFE_E_INSUFFICIENT_BUFFER	Der Wert in cchDest ist 1 oder kleiner.

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

Bemerkungen

StringCchGetsEx- bietet zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCchGetsEx immer null beendet einen Nicht-Länge-Zielpuffer.

Der Wert pszDest- sollte nicht NULL- sein, es sei denn, das STRSAFE_IGNORE_NULLS Flag ist angegeben. Ein Fehler aufgrund unzureichender Leerzeichen kann jedoch weiterhin zurückgegeben werden, obwohl NULL- Werte ignoriert werden.

StringCchGetsEx- kann in der 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 dargestellt.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCchGetsExA-
TCHAR-	TEXT("Zeichenfolge")	StringCchGetsEx-
WCHAR-	L"string"	StringCchGetsExW-

Anmerkung

Der strsafe.h-Header definiert StringCchGetsEx 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
mindestens unterstützte Client-	Windows XP mit SP2 [Desktop-Apps \| UWP-Apps]
mindestens unterstützte Server-	Windows Server 2003 mit SP1 [Desktop-Apps \| UWP-Apps]
Zielplattform-	Fenster
Header-	strsafe.h

Siehe auch

Referenz-

StringCbGetsEx-

StringCchGets-

Freigeben über