4. snprintf

最終更新日時:
が更新

履歴 編集

function
<cstdio>

std::snprintf(C++11)

namespace std {
  int snprintf(char* buffer, size_t n, const char* format, ...);
}

概要

書式を指定して、文字数の上限つきで文字列領域に出力する。

出力される文字数は、ヌル文字を含めてn文字以下に制限される。nが0より大きい場合、出力の末尾には必ずヌル文字が書き込まれる。

戻り値

nが十分に大きければ書き込まれたはずの文字数（ヌル文字を含まない）を返す。出力エラーが発生した場合は負の値を返す。

つまり、戻り値がn以上である場合は、出力が切り詰められたことを意味する。

備考

  • sprintf()と違って書き込む文字数の上限を指定できるため、バッファオーバーランを避けられる
  • nが0の場合、bufferはヌルポインタでもよく、なにも書き込まれない。この性質を利用して、必要なバッファサイズを事前に求められる
  • C++の文字列フォーマットには、型安全なstd::format()（C++20）も使用できる

例

#include <cstdio>

int main()
{
  char buffer[8];

  // バッファに収まる場合
  int len = std::snprintf(buffer, sizeof(buffer), "%d-%d", 12, 34);
  std::printf("%s (%d)\n", buffer, len);

  // バッファに収まらない場合は切り詰められる。
  // 戻り値は、収まったとしたら必要だった文字数
  len = std::snprintf(buffer, sizeof(buffer), "%d-%d", 123456, 789);
  std::printf("%s (%d)\n", buffer, len);
}

出力

12-34 (5)
123456- (10)

処理系

備考

  • 動作確認した範囲での最小バージョンを記載している。Clangは3.4（Compiler Explorerで利用できる最古のバージョン）、Visual C++は2019（同左）で動作を確認しており、それ以前のバージョンでも使用できる可能性がある

関連項目