The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

WindowsDeleteString function

Decrements the reference count of a string buffer.

Syntax

C++


HRESULT WINAPI WindowsDeleteString(
  _In_ HSTRING string
);

Parameters

string [in]

Type: HSTRING

The string to be deleted. If string is a fast-pass string created by WindowsCreateStringReference, or if string is NULL or empty, no action is taken and S_OK is returned.

Return value

Type: HRESULT

This function always returns S_OK.

Remarks

Use the WindowsDeleteString function to de-allocate an HSTRING. Calling WindowsDeleteString decrements the reference count of the backing buffer, and if the reference count reaches 0, the Windows Runtime de-allocates the buffer.

Requirements

Minimum supported client	Windows 8 [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2012 [desktop apps \| Windows Store apps]
Minimum supported phone	Windows Phone 8
Header	Winstring.h