Namespaces
Variants
Views
Actions

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

From cppreference.com
< cpp‎ | string‎ | basic string
(add example)
(fmt example, caps)
Line 18: Line 18:
  
 
===Return value===
 
===Return value===
reference to the requested character
+
Reference to the requested character.
  
 
===Exceptions===
 
===Exceptions===
throws {{lc|std::out_of_range}} if {{c|1=pos >= size()}}
+
Throws {{lc|std::out_of_range}} if {{c|1=pos >= size()}}.
  
 
===Complexity===
 
===Complexity===
Constant
+
Constant.
  
 
===Example===
 
===Example===
Line 35: Line 35:
 
int main()
 
int main()
 
{
 
{
  std::string s("message"); // for capacity
+
    std::string s("message"); // for capacity
  
  s = "abc";
+
    s = "abc";
  s.at(2) = 'x'; // ok
+
    s.at(2) = 'x'; // ok
  std::cout << s << '\n';
+
    std::cout << s << '\n';
  
  std::cout << "string size = " << s.size() << '\n';
+
    std::cout << "string size = " << s.size() << '\n';
  std::cout << "string capacity = " << s.capacity() << '\n';
+
    std::cout << "string capacity = " << s.capacity() << '\n';
  
  try {
+
    try {
    // throw, even if capacity allowed to access element
+
        // throw, even if capacity allowed to access element
    s.at(3) = 'x';
+
        s.at(3) = 'x';
  }
+
    }
  catch (std::out_of_range& exc) {
+
    catch (std::out_of_range& exc) {
    std::cout << exc.what() << '\n';
+
        std::cout << exc.what() << '\n';
  }
+
    }
 
}
 
}
 
| output=
 
| output=

Revision as of 13:17, 10 September 2013

 
 
 
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 );
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

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>
 
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

See also

accesses the specified character
(public member function) [edit]