Namespaces
Variants
Views
Actions

std::basic_string<CharT,Traits,Allocator>::c_str

From cppreference.com
< cpp‎ | string‎ | basic string
 
 
 
std::basic_string
Member functions
Element access
basic_string::c_str
Iterators
Capacity
Operations
Search
Constants
Deduction guides (C++17)
Non-member functions
I/O
Comparison
(until C++20)(until C++20)(until C++20)(until C++20)(until C++20)(C++20)
Numeric conversion
(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Helper classes
 
const CharT* c_str() const;
(until C++11)
const CharT* c_str() const noexcept;
(since C++11)
(until C++20)
constexpr const CharT* c_str() const noexcept;
(since C++20)

Returns a pointer to a null-terminated character array with data equivalent to those stored in the string.

The pointer is such that the range [c_str(); c_str() + size()] is valid and the values in it correspond to the values stored in the string with an additional null character after the last position.

The pointer obtained from c_str() may be invalidated by:

Writing to the character array accessed through c_str() is undefined behavior.

c_str() and data() perform the same function.

(since C++11)

Contents

[edit] Parameters

(none)

[edit] Return value

Pointer to the underlying character storage.

c_str()[i] == operator[](i) for every i in [0, size()).

(until C++11)

c_str() + i == std::addressof(operator[](i)) for every i in [0, size()].

(since C++11)

[edit] Complexity

Constant.

[edit] Notes

The pointer obtained from c_str() may only be treated as a pointer to a null-terminated character string if the string object does not contain other null characters.

[edit] Example

#include <algorithm>
#include <cassert>
#include <cstring>
#include <string>
 
int main()
{
  std::string const s("Emplary");
  const char* p = s.c_str();
  assert(s.size() == std::strlen(p));
  assert(std::equal(s.begin(), s.end(), p));
  assert(std::equal(p, p + s.size(), s.begin()));
  assert(0 == *(p + s.size()));
}

[edit] See also

(C++11)
accesses the first character
(public member function) [edit]
(C++11)
accesses the last character
(public member function) [edit]
returns a pointer to the first character of a string
(public member function) [edit]