Information
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.

WindowsGetStringRawBuffer function

Gets the backing buffer for the specified string.

Syntax


PCWSTR WINAPI WindowsGetStringRawBuffer(
  _In_       HSTRING string,
  _Out_opt_  UINT32 *length
);

Parameters

string [in]

Type: HSTRING

The string for which the backing buffer is to be retrieved.

length [out, optional]

Type: UINT32*

The number of Unicode characters in the backing buffer for string, including embedded null characters, but excluding the terminating null; or 0 if string is NULL.

Return value

Type: PCWSTR

A pointer to the buffer that provides the backing store for string, or the empty string if string is NULL or the empty string.

Remarks

Use the WindowsGetStringRawBuffer function to obtain a pointer to the backing buffer of an HSTRING.

Do not change the contents of the buffer as all HSTRINGs are required to be immutable.

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

 

 

Community Additions

Show:
© 2015 Microsoft