WindowsDeleteStringBuffer-Funktion (winstring.h)

Artikel
08/27/2023

Verwirft einen vorab zugeordneten Zeichenfolgenpuffer, wenn er nicht zu einem HSTRING heraufgestuft wurde.

Syntax

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

Parameter

bufferHandle

Typ: [in] HSTRING_BUFFER

Der zu verwerfende Puffer. Die WindowsDeleteStringBuffer-Funktion löst eine Ausnahme aus, wenn bufferHandle nicht durch einen Aufruf der WindowsPreallocateStringBuffer-Funktion zugeordnet wurde.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Der Puffer wurde erfolgreich verworfen.
E_POINTER	bufferHandle ist NULL.

Hinweise

Verwenden Sie die WindowsDeleteStringBuffer-Funktion, um einen Zeichenfolgenpuffer zu verwerfen, der von der WindowsPreallocateStringBuffer-Funktion erstellt wurde, aber nicht von der WindowsPromoteStringBuffer-Funktion zu einem HSTRING heraufgestuft wurde.

Hinweis Das Aufrufen von WindowsPromoteStringBuffer nach dem Aufrufen von WindowsDeleteStringBuffer mit demselben Pufferhandle ist nicht definiert.

Beispiele

Im folgenden Codebeispiel wird die Verwendung der Funktion WindowsDeleteStringBuffer veranschaulicht.

int main()
{
    HSTRING_BUFFER hStringBuffer = NULL;
    PWSTR strBuffer = NULL;
    HRESULT hr = WindowsPreallocateStringBuffer(10, &strBuffer, &hStringBuffer);

    // You hit a case in which you need to discard the buffer.

    WindowsStringDeleteBuffer(hStringBuffer);
}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	winstring.h
Bibliothek	RuntimeObject.lib
DLL	ComBase.dll

Weitere Informationen

HSTRING

HSTRING_BUFFER

WindowsPreallocateStringBuffer

WindowsPromoteStringBuffer

Freigeben über