Return a substring of string starting at position.

Synopsis

Declared in <bdlb_stringrefutil.h>

static
bslstl::StringRef
substr(
    bslstl::StringRef const& string,
    size_type position = 0,
    size_type numChars = k_NPOS);

Description

Return a string whose value is the substring starting at the optionally specified position in the specified string, of length the optionally specified numChars or length() ‐ position, whichever is smaller. If position is not specified, 0 is used (i.e., the substring is from the beginning of this string). If numChars is not specified, k_NPOS is used (i.e., the entire suffix from position to the end of the string is returned). The behavior is undefined unless position is within the string boundaries (0 <= position <= string.length()).

Return Value

substring of string starting at position

Parameters

Name

Description

string

string from which the substring is taken

position

starting index of the substring (0 if not specified)

numChars

maximum length of the substring (k_NPOS if not specified)

Created with MrDocs