Std::string::substr

From aldeid
Jump to: navigation, search

Syntax

string substr (size_t pos = 0, size_t len = npos) const;

Description

Generate substring

Returns a newly constructed string object with its value initialized to a copy of a substring of this object.

The substring is the portion of the object that starts at character position pos and spans len characters (or until the end of the string, whichever comes first).

Parameters

pos
Position of the first character to be copied as a substring.
If this is equal to the string length, the function returns an empty string.
If this is greater than the string length, it throws out_of_range.
Note: The first character is denoted by a value of 0 (not 1).
len
Number of characters to include in the substring (if the string is shorter, as many characters as possible are used).
A value of string::npos indicates all characters until the end of the string.

size_t is an unsigned integral type (the same as member type string::size_type).

Return Value

A string object with a substring of this object.

Example

Source Output
#include <iostream>
#include <string>
using namespace std;

int main()
{
  string str("Hello world, this is a test in C++");
  cout << str.substr(13, 14) << endl;
  return 0;
}
this is a test