StringCbGetsExA-Funktion (strsafe.h)

  • Artikel

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.
 
StringCbGetsEx fügt die Funktionalität von StringCbGets hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der Bytes zurückgegeben wird, die in dieser Zeichenfolge nicht verwendet werden. Flags können auch an die Funktion für ein zusätzliches Steuerelement übergeben werden.

StringCbGetsEx ist ein Ersatz für die folgenden Funktionen:

StringCbGetsEx ist kein Ersatz für fgets, wodurch keine Zeilenumbruchzeichen durch ein endendes NULL-Zeichen ersetzt werden.

Syntax

STRSAFEAPI StringCbGetsExA(
  [out]           STRSAFE_LPSTR pszDest,
  [in]            size_t        cbDest,
  [out, optional] STRSAFE_LPSTR *ppszDestEnd,
  [out, optional] size_t        *pcbRemaining,
  [in]            DWORD         dwFlags
);

Parameter

[out] pszDest

Typ: LPTSTR

Der Zielpuffer, der die Eingabe empfangen soll.

[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 maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR). Wenn cbDest zu klein ist, um die vollständige Textzeile aufzunehmen, werden die Daten abgeschnitten.

[out, optional] ppszDestEnd

Typ: LPTSTR*

Die Adresse eines Zeigers auf das Ende von pszDest. Wenn ppszDestEnd nicht NULL ist und alle Daten in den Zielpuffer kopiert werden, zeigt dies auf das beendende NULL-Zeichen am Ende der Zeichenfolge.

[out, optional] pcbRemaining

Typ: size_t*

Die Anzahl der nicht verwendeten Bytes in pszDest, einschließlich der bytes, die für das beendende NULL-Zeichen verwendet werden. Wenn pcbRemainingNULL ist, wird die Anzahl nicht beibehalten oder zurückgegeben.

[in] dwFlags

Art: 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 von pszDest nach dem beendenden NULL-Zeichen zu füllen.
STRSAFE_IGNORE_NULLS
0x00000100
 Behandeln Sie NULL-Zeichenfolgenzeiger wie leere Zeichenfolgen (TEXT("").). Dieses Flag ist nützlich, um Funktionen wie lstrcpy zu emulieren.
STRSAFE_FILL_ON_FAILURE
0x00000400
 Wenn die Funktion fehlschlägt, wird das niedrige Byte von dwFlags (0) verwendet, um den gesamten pszDest-Puffer zu füllen, und der Puffer ist NULL-beendet. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede zurückgegebene abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NULL_ON_FAILURE
0x00000800
 Wenn die Funktion fehlschlägt, wird pszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben.
STRSAFE_NO_TRUNCATION
0x00001000
 Wenn die Funktion fehlschlägt, wird wie bei STRSAFE_NULL_ON_FAILUREpszDest auf eine leere Zeichenfolge (TEXT("")) festgelegt. Im Falle eines STRSAFE_E_INSUFFICIENT_BUFFER Fehlers wird jede abgeschnittene Zeichenfolge überschrieben.

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, in den Puffer bei pszDest 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, oder ein ungültiges Flag wurde übergeben.
STRSAFE_E_INSUFFICIENT_BUFFER
 Der Wert in cbDest ist 1 oder weniger.
 

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

Hinweise

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

Der Wert von pszDest sollte nicht NULL sein, es sei denn, das flag STRSAFE_IGNORE_NULLS ist angegeben. Ein Fehler aufgrund unzureichenden Speicherplatzes kann jedoch trotzdem zurückgegeben werden, obwohl NULL-Werte ignoriert werden.

StringCbGetsEx 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“ StringCbGetsExA
TCHAR TEXT("string") StringCbGetsEx
WCHAR L"Zeichenfolge" StringCbGetsExW
 

Hinweis

Der strsafe.h-Header definiert StringCbGetsEx 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

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

StringCbGets

StringCchGetsEx