C ライブラリ関数 -snprintf()
説明
snprintf() は C 言語の標準ライブラリ関数であり、文字列をフォーマットして指定されたバッファに書き込むために使用されます。sprintf() とは異なり、snprintf() は出力する文字数を制限し、バッファオーバーフローを防ぎます。
とsprintf()sprintf() と異なり、snprintf() 関数は size パラメータを提供しており、バッファオーバーフローを防ぐことができます。フォーマット後の文字列の長さが size-1 を超える場合、snprintf() は size-1 個の文字だけを書き込み、文字列の末尾に終端を示すヌル文字(\0)を追加します。
宣言
以下は snprintf() 関数の宣言です。
int snprintf ( char * str, size_t size, const char * format, ... );
int snprintf(char *str, size_t size, const char *format, ...)可変引数を(...)に従ってformat文字列にフォーマットし、その文字列をコピーしてstr中に、size書き込む文字数の最大値であり、それを超えるとsize切り詰められ、最大で size-1 個の文字が書き込まれます。
パラメータ
- str-- 対象文字列: フォーマット後の文字列を格納する文字配列へのポインタ。
- size-- 文字配列のサイズ。
- format-- フォーマット文字列。
- ...-- 可変引数: 可変数の引数は、format 内のフォーマット指示に従ってフォーマットされます。
戻り値
戻り値は整数です:
-
成功した場合、書き込まれるはずだった文字数(末尾のヌル文字は含まない)を返します。この値が size より大きくても同様です。
-
エンコードエラーが発生した場合は、負の値を返します。
例
以下の例は、snprintf() 関数の使い方を示しています。
例
int main()
{
char buffer[50];
char* s = "サンプルcom";
// 文字列を読み取り、buffer に格納する
int j = snprintf(buffer, 6, "%s\n", s);
// buffer と文字数を出力する
printf("string:\n%s\ncharacter count = %d\n", buffer, j);
return 0;
}
出力結果は次のとおりです:
string: runoo character count = 10
以下は、使用方法を示す例です%fフォーマット指定子を使って snprintf() で単精度浮動小数点数を出力します:
例
int main() {
char buffer[50];
float x = 3.1415926;
int len = snprintf(buffer, 50, "x = %f", x);
printf("%s\n", buffer);
printf("Written characters: %d\n", len);
return 0;
}
出力結果は次のとおりです:
x = 3.141593 Written characters: 12
上記の例では、snprintf() は文字列 "x = 3.141593" を buffer バッファに書き込み、文字列の長さ 12 を返します。buffer のサイズが 50 であるため、文字列の末尾にはヌル文字が付きます。最後に、プログラムは buffer 内の文字列と snprintf() が返した文字数を出力します。
注意事項:
バッファサイズ:
snprintf()関数は出力する文字数を制限しますが、フォーマット後の文字列を格納できるように、渡すバッファサイズが十分であることを確認する必要があります。そうしないと、文字列が切り詰められ、情報が失われる可能性があります。文字列終端文字:
snprintf()関数はバッファの最後に文字列の終端文字としてヌル文字を追加しますが、この文字は戻り値には含まれません。したがって、使用する際はsnprintf()文字列を出力するときは、文字列のすべての文字と末尾のヌル文字を格納できるよう、バッファサイズが十分であることを確認する必要があります。フォーマット文字列: 使用する際は
snprintf()フォーマット文字列を使用するときは、フォーマット文字列内のフォーマット指定子と可変引数の型が一致していることを確認する必要があります。そうしないと、出力結果にエラーが発生する可能性があります。戻り値:
snprintf()関数の戻り値はバッファに書き込まれた文字数ですが、文字列末尾のヌル文字は含まれません。戻り値がバッファサイズと等しい場合、出力結果が切り詰められたことを示します。可変引数:
snprintf()関数の可変引数は...渡されます。つまり、フォーマット指定子に一致する型で可変引数を渡す必要があります。可変引数を使用する際は、未初期化の変数を使用しないようにしてください。そうしないと、予測不能な結果が生じる可能性があります。
要するに、snprintf() 関数を使用する際は、バッファサイズ、文字列終端文字、フォーマット文字列、戻り値、可変引数などの問題に注意して、出力結果が正確であることを確認する必要があります。
その他の拡張