Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | string‎ | basic string
(Rephrase misleading comment)
m (See also: + crosslink)
Line 70: Line 70:
 
{{dsc begin}}
 
{{dsc begin}}
 
{{dsc inc | cpp/string/basic_string/dsc operator_at }}
 
{{dsc inc | cpp/string/basic_string/dsc operator_at }}
 +
{{dsc inc | cpp/string/basic_string_view/dsc {{SUBPAGENAMEE}}}}
 
{{dsc end}}
 
{{dsc end}}
  
 
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}
 
{{langlinks|de|es|fr|it|ja|pl|pt|ru|zh}}

Revision as of 04:16, 4 May 2021

 
 
 
std::basic_string
Member functions
Element access
basic_string::at
Iterators
Capacity
Modifiers
Search
Operations
Constants
Non-member functions
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
Helper classes
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

#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 {
        // This will throw since the requested offset is greater than the current size.
        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]
accesses the specified character with bounds checking
(public member function of std::basic_string_view<CharT,Traits>) [edit]