関数CKfgets マニュアル

(The documentation of function CKfgets)
Last Update: 2023/4/11


◆機能・用途(Purpose)

関数fgets(ファイルからの1行の読み込み)をエラーチェック付きで実行する。
Call function fgets (reading a line from a file) with error checks.

◆形式(Format)

#include <functions_with_errcheck.h>
inline char ∗CKfgets(FILE ∗stream)


◆引数(Arguments)

stream 読み込むファイルのファイルポインタ。
The file pointer of the file to read.


◆戻り値とエラーチェック (Return value and error checks)

下表で桃色のセルがエラー処理を表す。
The pick colored cells in the table below represent error checks.
条件
Condition 		戻り値/動作
Return value or behaviour of the function
stream=NULL プログラムをエラー終了する。
The program finishes as an error.
streamが既にファイルエンドに達している場合
The stream has already reached the file end 		プログラムをエラー終了する。
The program finishes as an error.
streamから関数fgetsを用いて1行を読み込んだところファイルエンドに達した
The program reached the file end by reading a line from stream using function fgets 		プログラムをエラー終了する。
The program finishes as an error.
streamから関数fgetsを用いて1行を読み込んだところ戻り値がNULLであった
The return value of function fgets for reading a line from stream was NULL 		プログラムをエラー終了する。
The program finishes as an error.
streamから関数fgetsを用いて1行を読み込んだところ 改行文字(\n)まで読み込めなかった
The program could not read a linebreak character (\n) by reading a line from stream using function fgets 		プログラムをエラー終了する。
The program finishes as an error.
上記以外の場合
The other cases 		関数fgetsを用いてstreamから1行読み込んで文字列(char型変数配列)に格納し、 末尾の\nあるいは\rを\0に置換して戻り値として返す。
Read a line from stream using function fgets, insert the contents of the line into a string (a char-type array), replace \n and \r at the end with \0, and returns it as the return value.


◆使用例(Example)

FILE ∗fp;
char ∗linecontents=CKfgets(fp);


◆追記(Additional remarks)

関数fgetsとは用法が異なることに留意。
Note that the usage is different from that of function fgets.