Expand Minimize

WindowsDeleteString function

Decrements the reference count of a string buffer.

Syntax


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.

Windows Phone 8: This API is supported.

Windows Phone 8.1: This API is supported.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

Winstring.h

See also

WindowsCreateString
WindowsCreateStringReference

 

 

Community Additions

ADD
Show:
© 2014 Microsoft