WindowsDeleteStringBuffer function (winstring.h)

Discards a preallocated string buffer if it was not promoted to an HSTRING.

Syntax

HRESULT WindowsDeleteStringBuffer(
  HSTRING_BUFFER bufferHandle
);

Parameters

bufferHandle

Type: [in] HSTRING_BUFFER

The buffer to discard. The WindowsDeleteStringBuffer function raises an exception if bufferHandle was not allocated by a call to the WindowsPreallocateStringBuffer function.

Return value

Type: HRESULT

This function can return one of these values.

Remarks

Use the WindowsDeleteStringBuffer function to discard a string buffer that was created by the WindowsPreallocateStringBuffer function but has not been promoted to an HSTRING by the WindowsPromoteStringBuffer function.

Examples

The following code example demonstrates how to use the WindowsDeleteStringBuffer function.

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);
}

Requirements

See also

HSTRING

HSTRING_BUFFER

WindowsPreallocateStringBuffer

WindowsPromoteStringBuffer