snprintf (C99)

文字列書式に従って指定文字数分だけ文字配列に書き込みます． 

#include <stdio.h>

int snprintf(
    char * restrict s,
    size_t n,
    const char * restrict format,
    ...
);

snprintf 関数は format が指す書式文字列に従って s が指す文字配列へ書き込みを行います．文字配列に書き込んだ文字列の後にはナル文字 ('\0') が書き込まれます．

n-1 番目より後の出力文字は文字配列に書き込まずに破棄されます．つまり，引数 n に 0 を指定した場合は snprintf は何も書き込みません．この場合，引数 s に空ポインタ (NULL) を指定してもかまいません．

領域の重なり合うオブジェクト間でコピーが行われるとき，その動作は未定義です．

引数

  • s: 文字配列 (ここに書き込まれる)
  • n: 書き込む文字数の最大値
  • format: 書式文字列 (詳しくは printf の書式文字列を参照してください)

戻り値

  • 成功した場合: 書き込んだ文字数 (終端ナル文字は含めない)
  • 失敗した場合: 負の値

※ 戻り値が負の値でなく n 未満の場合に完全に書き込まれたといえます．

C言語サンプルプログラム

snprintf 関数を使用して指定文字数分だけ文字配列に書き込むサンプルプログラムを以下に示します．

/* header files */
#include <stdio.h>
#include <stdlib.h>

/* macros */
#define N 256

/* main */
int main(void) {
    char s[N] = {'\0'};
    char name[] = "チャーリー・ブラウン";
    char sex[] = "男性";
    int age = 4;

    snprintf(s, N, "%sさんは%d歳の%sです．", name, age, sex);

    printf("%s\n", s);

    return EXIT_SUCCESS;
}

実行例

サンプルプログラムの実行結果は以下のようになります．

チャーリー・ブラウンさんは4歳の男性です．