Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/string/basic string/at"

From cppreference.com
< cpp‎ | string‎ | basic string
m (→‎Example: returned string of what() is implementation-defined)
m
Line 72: Line 72:
 
{{dsc end}}
 
{{dsc end}}
  
−
{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
+
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}

Revision as of 02:26, 18 February 2020

 
C++
 
Strings library
 
std::basic_string
Member functions
(C++23)
Element access
basic_string::at
(DR*)
(DR*)
(C++17)
Iterators
(C++11)
(C++11)
(C++11)
(C++11)
Capacity
(DR*)
Modifiers
(C++23)
(DR*)
(C++23)
(C++23)
(C++23)  
Search
Operations
(C++20)
(C++20)
(C++23)
Constants
Non-member functions
(C++20)(C++20)
I/O
Comparison
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)
Numeric conversions
(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Literals
(C++14)
Helper classes
(C++11)
Deduction guides (C++17)

 
reference       at( size_type pos );
 (until C++20)
constexpr reference       at( size_type pos );
 (since C++20)
const_reference at( size_type pos ) const;
 (until C++20)
constexpr const_reference at( size_type pos ) const;
 (since C++20)

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

Parameters

pos - position of the character to return

Return value

Reference to the requested character.

Exceptions

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

Complexity

Constant.

Example

Run this code
#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 const& exc) {
        std::cout << exc.what() << '\n';
    }
}

Possible output: 

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

See also

 accesses the specified character
(public member function) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/string/basic_string/at&oldid=116442"