StringCbCopyExA-Funktion (strsafe.h)

Artikel
11/20/2024

Kopiert eine Zeichenfolge in eine andere. Die Größe des Zielpuffers wird der Funktion bereitgestellt, um sicherzustellen, dass er nicht über das Ende dieses Puffers schreibt.

StringCbCopyEx der Funktionalität von StringCbCopy hinzu, indem ein Zeiger auf das Ende der Zielzeichenfolge sowie die Anzahl der in dieser Zeichenfolge nicht verwendeten Bytes zurückgegeben wird. Flags können auch an die Funktion übergeben werden, um zusätzliche Steuerelemente zu erhalten.

StringCbCopyEx ist ein Ersatz für die folgenden Funktionen:

Syntax

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

Parameter

[out] pszDest

Typ: LPTSTR-

Der Zielpuffer, der die kopierte Zeichenfolge empfängt.

[in] cbDest

Typ: size_t

Die Größe des Zielpuffers in Byte. Dieser Wert muss die Länge pszSrc- plus das endierende Nullzeichen berücksichtigen. Die maximale Anzahl zulässiger Bytes ist STRSAFE_MAX_CCH * sizeof(TCHAR).

[in] pszSrc

Typ: LPCTSTR-

Die Quellzeichenfolge. Diese Zeichenfolge muss null beendet werden.

[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] pcbRemaining

Typ: size_t*

Die Anzahl der nicht verwendeten Bytes in pszDest, einschließlich derjenigen, die für das endende Nullzeichen verwendet werden. Wenn pcbRemainingNULList, 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_FAILUREauf 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	Quelldaten wurden vorhanden, vollständig ohne Abschneiden kopiert, und der resultierende Zielpuffer wird null beendet.
STRSAFE_E_INVALID_PARAMETER	Entweder pszDest- ist NULL-, wenn Quelldaten zum Kopieren vorhanden sind oder ein ungültiges Flag übergeben wurde.
STRSAFE_E_INSUFFICIENT_BUFFER	Fehler beim Kopiervorgang aufgrund unzureichender Pufferspeicher. Abhängig vom Wert von dwFlagskann der Zielpuffer eine abgeschnittene, null-beendete Version des beabsichtigten Ergebnisses enthalten. In Situationen, in denen abgeschnitten werden kann, kann dies möglicherweise nicht unbedingt als Fehlerbedingung angesehen werden.

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

Bemerkungen

Im Vergleich zu den ersetzten Funktionen bietet StringCbCopyEx- zusätzliche Verarbeitung für die ordnungsgemäße Pufferverarbeitung in Ihrem Code. Eine schlechte Pufferbehandlung ist in vielen Sicherheitsproblemen mit Pufferüberläufen verbunden. StringCbCopyEx immer null beendet und überläuft niemals einen gültigen Zielpuffer, auch wenn sich der Inhalt der Quellzeichenfolge während des Vorgangs ändert.

Das Verhalten ist nicht definiert, wenn sich die Zeichenfolgen, auf die pszSrc und pszDest verweisen, überlappen.

Weder pszSrc noch pszDest- sollte NULL- sein, es sei denn, das STRSAFE_IGNORE_NULLS Flag ist angegeben, in diesem Fall kann beide NULLsein. Ein Fehler aufgrund unzureichender Leerzeichen kann jedoch weiterhin zurückgegeben werden, obwohl NULL- Werte ignoriert werden.

StringCbCopyEx- kann in der generischen Form oder in spezifischeren Formularen verwendet werden. Der Datentyp der Zeichenfolge bestimmt die Form dieser Funktion, die Sie verwenden sollten.

String-Datentyp	Zeichenfolgenliteral	Funktion
Zeichen-	"string"	StringCbCopyExA-
TCHAR-	TEXT("Zeichenfolge")	StringCbCopyEx-
WCHAR-	L"string"	StringCbCopyExW-

Anmerkung

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

StringCbCopy-

StringCchCopyEx-

Freigeben über