const charT* data() const;                    // (1) C++98
const charT* data() const noexcept;           // (1) C++11
constexpr const charT* data() const noexcept; // (1) C++20

charT* data() noexcept;                       // (2) C++17
constexpr charT* data() noexcept;             // (2) C++20

概要

文字配列表現を取得する。

• (1) : 読み取り専用で文字配列の先頭へのポインタを取得する
• (2) : 文字配列の先頭へのポインタを取得する

戻り値

• (1) :
  • C++98 : 文字配列の先頭へのポインタを返す。ただし、NULLで終端はされない
  • C++11 : C 言語で使用されている文字列表現である、NULL（つまり charT()）で終端された文字配列の先頭へのポインタを返す
• (2) :
  • C 言語で使用されている文字列表現である、NULL（つまり charT()）で終端された文字配列の先頭へのポインタを返す

計算量

• (1) :
  • C++98まで : 規定なし
  • C++11から : 定数時間
• (2) : 定数時間

例外

• (1) :
  • C++98まで : 規定なし
  • C++11から : 投げない
• (2) : 投げない

備考

• (1) :
  • C++98まで :
    • 本メンバ関数で返されたポインタが指す配列の値を変更してはいけない。
    • 本メンバ関数を呼び出すと、対象オブジェクトの要素への既存の参照、ポインタ、イテレータは無効になる可能性がある。
    • 本メンバ関数で返されたポインタは、対象オブジェクトに対する非constメンバ関数呼び出しにより無効になる可能性がある。
      • なお、規格書に記載はないものの、basic_string への非const参照を引数に取る標準ライブラリ関数を、対象オブジェクトを渡して呼び出した場合にも、無効になる可能性があるものと思われる
    • 本メンバが返すポインタは、size() != 0 の場合、長さが size() の charT 型の配列を指す。この配列の要素は対象オブジェクトの文字列と等しい。
    • size() == 0 の場合、NULL ポインタではなく、当該ポインタのコピー、および、当該ポインタに対してゼロの加算が可能な値である。
    • c_str() と異なり、本メンバ関数で返る配列は NULL（charT()）で終端されていないので、注意すること。（通常は、size() と併せて利用することになるだろう）
  • C++11から :
    • c_str()メンバ関数と同一の動作をする。
    • 本メンバ関数を呼び出しても、対象オブジェクトの要素への既存の参照、ポインタ、イテレータは無効にはならない。
    • 本メンバ関数で返されたポインタは、対象オブジェクトに対する非constメンバ関数呼び出しにより無効になる可能性がある。
    • 本メンバが返すポインタは、長さが size() + 1 の charT 型の配列を指す。この配列は、最初の size() 要素は対象オブジェクトの文字列と等しく、最後の要素は NULL 文字、すなわち charT() である。
      • 本メンバ関数が返すポインタを p とすると、範囲 [0, size()] の全ての i について p + i == addressof(operator[](i)) を満たす。このことから、*end() == charT() を満たす。
• 対象オブジェクト内に NULL 文字があった場合、C 言語の文字列表現では正しく扱うことができないので注意すること。
• (2) :
  • この関数を使用するユーザーは、p + size() (NULL終端) に格納されている値を変更してはならない
  • この関数を呼び出しても、対象オブジェクトの要素への既存の参照、ポインタ、イテレータは無効にはならない

例

#include <string>
#include <cstdio>
#include <cstring>

int main()
{
  std::string s("Hello, world!\n");
  std::fwrite(s.data(), 1, s.size(), stdout);
}

出力

Hello, world!

関連項目

参照

• LWG Issue 876. basic_string access operations should give stronger guarantees
  • C++11で、例外を送出しないことと計算量が定数時間であることが規定された
• P0272R1 Give std::string a non-const .data() member function.
• LWG Issue 2760. non-const basic_string::data should not invalidate iterators
  • C++17の策定中に、P0272R1で追加された非const版data()が、参照・ポインタ・イテレータを無効化しない関数の一覧に含まれていなかった記載漏れが修正された
• LWG Issue 3131. addressof all the things
• P0980R1 Making std::string constexpr