std::basic_string<CharT,Traits,Allocator>::data
| const CharT* data() const; |
(1) | (noexcept since C++11) (constexpr since C++20) |
| CharT* data() noexcept; |
(2) | (since C++17) (constexpr since C++20) |
Returns a pointer to the underlying array serving as character storage. The pointer is such that the range
|
|
(until C++11) |
|
|
(since C++11) |
is valid and the values in it correspond to the values stored in the string.
|
The returned array is not required to be null-terminated. If empty() returns true, the pointer is a non-null pointer that should not be dereferenced. |
(until C++11) |
|
The returned array is null-terminated, that is, If empty() returns true, the pointer points to a single null character. |
(since C++11) |
The pointer obtained from data() may be invalidated by:
- Passing a non-const reference to the string to any standard library function, or
- Calling non-const member functions on the string, excluding
operator[](), at(), front(), back(), begin(), end(), rbegin(), rend().
data has undefined behavior.data() + size() to any value other than CharT() has undefined behavior.Parameters
(none)
Return value
A pointer to the underlying character storage.
|
data()[i] == operator[](i) for every |
(until C++11) |
|
data() + i == std::addressof(operator[](i)) for every |
(since C++11) |
Complexity
Constant.
Example
#include <algorithm> #include <cassert> #include <cstring> #include <string> int main() { std::string const s("Emplary"); assert(s.size() == std::strlen(s.data())); assert(std::equal(s.begin(), s.end(), s.data())); assert(std::equal(s.data(), s.data() + s.size(), s.begin())); assert('\0' == *(s.data() + s.size())); }
See also
| (DR*) |
accesses the first character (public member function) |
| (DR*) |
accesses the last character (public member function) |
| returns a non-modifiable standard C character array version of the string (public member function) | |
| returns a pointer to the first character of a view (public member function of std::basic_string_view<CharT,Traits>) |