public member function

std::string::cend

const_iterator cend() const noexcept;

Return const_iterator to end

Returns a const_iterator pointing to the past-the-end character of the string.

const_iterator is an iterator that points to const content. This iterator can be increased and decreased (unless it is itself also const), just like the iterator returned by string::end, but it cannot be used to modify the contents it points to, even if the string object is not itself const.

If the object is an empty string, this function returns the same as string::cbegin.

The value returned shall not be dereferenced.

Parameters

none

Return Value

A const_iterator to the past-the-end of the string.

Member type

const_iterator is a random access iterator type that points to a const character.

Example

// string::cbegin/cend
#include <iostream>
#include <string>

int main ()
{
  std::string str ("Lorem ipsum");
  for (auto it=str.cbegin(); it!=str.cend(); ++it)
    std::cout << *it;
  std::cout << '\n';

  return 0;
}

Output:

Complexity

Unspecified, but generally constant.

Iterator validity

No changes.

Data races

The object is accessed.

Exception safety

No-throw guarantee: this member function never throws exceptions.
The copy construction or assignment of the returned iterator is also guaranteed to never throw.