Namespaces
Variants
Views
Actions

std::basic_string::at

From cppreference.com
< cpp‎ | string‎ | basic string
 
 
 
std::basic_string
 
reference       at( size_type pos );
const_reference at( size_type pos ) const;

Returns a reference to the character at specified location pos. Bounds checking is performed, exception of type std::out_of_range will be thrown on invalid access.

Contents

[edit] Parameters

pos - position of the character to return

[edit] Return value

Reference to the requested character.

[edit] Exceptions

Throws std::out_of_range if pos >= size().

[edit] Complexity

Constant.

[edit] Example

#include <stdexcept>
#include <iostream>
#include <string>
 
int main()
{
    std::string s("message"); // for capacity
 
    s = "abc";
    s.at(2) = 'x'; // ok
    std::cout << s << '\n';
 
    std::cout << "string size = " << s.size() << '\n';
    std::cout << "string capacity = " << s.capacity() << '\n';
 
    try {
        // throw, even if capacity allowed to access element
        s.at(3) = 'x';
    }
    catch (std::out_of_range& exc) {
        std::cout << exc.what() << '\n';
    }
}

Output:

abx
string size = 3
string capacity = 7
basic_string::at

[edit] See also

access specified character
(public member function) [edit]