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.

WindowsSubstring function

Retrieves a substring from the specified string. The substring starts at the specified character position.

Syntax

C++


HRESULT WINAPI WindowsSubstring(
  _In_  HSTRING string,
  _In_  UINT32  startIndex,
  _Out_ HSTRING *newString
);

Parameters

string [in]

Type: HSTRING

The original string.

startIndex [in]

Type: UINT32

The zero-based starting character position of a substring in this instance.

newString [out]

Type: HSTRING*

A string that is equivalent to the substring that begins at startIndex in string, or NULL if startIndex is equal to the length of string.

Return value

Type: HRESULT

This function can return one of these values.

Return code	Description
S_OK	The substring was created successfully.
E_INVALIDARG	newString is NULL.
E_BOUNDS	startIndex is greater than the length of string.
E_OUTOFMEMORY	Failed to allocate the new substring.

Remarks

Each call to the WindowsSubstring function must be matched with a corresponding call to WindowsDeleteString.

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