クラス File

ファイルを扱うためのクラス [詳細]

#include <sdmmc.h>

Public メソッド
void	close ()
	ファイルを閉じる [詳細]
bool	available ()
	読み出せるデータがあるかどうか調べる [詳細]
int	read ()
	ファイルから1バイト読み込む [詳細]
size_t	write (unsigned char c)
	ファイルに1バイト書き込む [詳細]
size_t	write (const char *str)
	ファイルに文字列を書き込む [詳細]
size_t	write (unsigned char *buf, int len)
	ファイルにバイナリデータを書き込む [詳細]
void	flush ()
	未書き込みのデータをファイルに書き込む [詳細]
unsigned char	peek ()
	ファイルから読み出すデータの先頭の1バイトを覗き見る。ファイルの読み出しポインタには影響を与えない。 [詳細]
unsigned long	position ()
	ファイルからの読み出し位置を取得する [詳細]
bool	seek (unsigned long pos)
	ファイルからの読み出し位置を移動する [詳細]
size_t	print (const char str[])
	ファイルに文字列を書き込む [詳細]
size_t	print (String str)
	ファイルにString型の文字列を書き込む(V1.081) [詳細]
size_t	print (const char c)
	ファイルに文字を書き込む [詳細]
size_t	print (unsigned char c, int print_type=DEC)
	ファイルに数値を書き込む [詳細]
size_t	print (int val, int print_type=DEC)
	ファイルに数値を書き込む [詳細]
size_t	print (unsigned int val, int print_type=DEC)
	ファイルに数値を書き込む [詳細]
size_t	print (long val, int print_type=DEC)
	ファイルに数値を書き込む [詳細]
size_t	print (unsigned long val, int print_type=DEC)
	ファイルに数値を書き込む [詳細]
size_t	print (double val, int fpdigit=2)
	ファイルに浮動小数点数を書き込む [詳細]
size_t	println (const char *str)
	ファイルに文字列を書き込み、改行コード(\r\n)を書き込む [詳細]
size_t	println (String str)
	ファイルにString型の文字列を書き込み、改行コード(\r\n)を書き込む(V1.081) [詳細]
size_t	println (const char c)
	ファイルに文字を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (unsigned char c, int print_type=DEC)
	ファイルに数値を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (int val, int print_type=DEC)
	ファイルに数値を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (unsigned int val, int print_type=DEC)
	ファイルに数値を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (long val, int print_type=DEC)
	ファイルに数値を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (unsigned long val, int print_type=DEC)
	ファイルに数値を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (double val, int fpdigit=2)
	ファイルに浮動小数点数を書き込み、改行コード(\n\r)を書き込む [詳細]
size_t	println (void)
	改行コードのみ出力する [詳細]
unsigned long	size ()
	ファイルのサイズを調べる [詳細]
char *	name ()
	開いているファイルの名前を調べる [詳細]
bool	isDirectory ()
	開いているファイルオブジェクトが、ファイルか、ディレクトリかを調べる [詳細]
File	openNextFile ()
	ディレクトリオブジェクトの場合、次のファイルオブジェクトを返す [詳細]
void	rewindDirectory ()
	ディレクトリの検索を最初に戻す [詳細]

説明

ファイルを扱うためのクラス

覚え書き

このファイルのオブジェクトは、 SDMMC::open() か File::openNextFile() によって返されるものを使うこと。ユーザプログラムが作成しないこと。

sdmmc.h の 49 行で定義されています。

関数

void File::close

(

)

ファイルを閉じる

警告

ファイルオブジェクトを使い終わるときに、最後に必ず呼び出すこと！

戻り値

なし

bool File::available

(

)

読み出せるデータがあるかどうか調べる

戻り値

データがればtrueを返す。なければfalseを返す。

int File::read

(

)

ファイルから1バイト読み込む

戻り値

データがあればそのデータ(0x00～0xff)を返す。ファイルの終わりに達していたら-1を返す。

size_t File::write

(

unsigned char

c

)

ファイルに1バイト書き込む

引数

c

書き込みたいデータ

戻り値

実際に出力した文字数

size_t File::write

(

const char *

str

)

ファイルに文字列を書き込む

引数

str

書き込みたい文字列

戻り値

実際に出力した文字数

size_t File::write	(	unsigned char *	buf,
		int	len
	)

ファイルにバイナリデータを書き込む

引数

[in]	buf	書き込みデータが格納されたバッファ
	len	書き込みたい長さ

戻り値

実際に出力したバイト数

void File::flush

(

)

未書き込みのデータをファイルに書き込む

戻り値

なし

unsigned char File::peek

(

)

ファイルから読み出すデータの先頭の1バイトを覗き見る。ファイルの読み出しポインタには影響を与えない。

引数

この関数は実装されていない

戻り値

文字コード(0～255)。

unsigned long File::position

(

)

ファイルからの読み出し位置を取得する

戻り値

ファイルの先頭から数えた読み出し位置 (バイト単位)

bool File::seek

(

unsigned long

pos

)

ファイルからの読み出し位置を移動する

引数

pos	ファイルの先頭から数えた読み出し位置 (バイト単位)

戻り値

成功したらtrueを返す。失敗したらfalseを返す。

size_t File::print

(

const char

str[]

)

ファイルに文字列を書き込む

引数

[in]

str

書き込みたい文字列

戻り値

実際に出力したバイト数

size_t File::print

(

String

str

)

ファイルにString型の文字列を書き込む(V1.081)

引数

[in]

str

書き込みたい文字列

戻り値

実際に出力したバイト数

size_t File::print

(

const char

c

)

ファイルに文字を書き込む

引数

[in]

c

書き込みたい文字コード

戻り値

実際に出力したバイト数

size_t File::print	(	unsigned char	c,
		int	print_type = DEC
	)

ファイルに数値を書き込む

引数

[in]	c	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::print	(	int	val,
		int	print_type = DEC
	)

ファイルに数値を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::print	(	unsigned int	val,
		int	print_type = DEC
	)

ファイルに数値を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数 4

size_t File::print	(	long	val,
		int	print_type = DEC
	)

ファイルに数値を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::print	(	unsigned long	val,
		int	print_type = DEC
	)

ファイルに数値を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::print	(	double	val,
		int	fpdigit = 2
	)

ファイルに浮動小数点数を書き込む

引数

[in]	val	書き込みたい数値
	fpdigit	桁数

戻り値

実際に出力したバイト数

size_t File::println

(

const char *

str

)

ファイルに文字列を書き込み、改行コード(\r\n)を書き込む

引数

[in]

str

書き込みたい文字列

戻り値

実際に出力したバイト数

size_t File::println

(

String

str

)

ファイルにString型の文字列を書き込み、改行コード(\r\n)を書き込む(V1.081)

引数

[in]

str

書き込みたい文字列

戻り値

実際に出力したバイト数

size_t File::println

(

const char

c

)

ファイルに文字を書き込み、改行コード(\n\r)を書き込む

引数

[in]

c

書き込みたい文字コード

戻り値

実際に出力したバイト数

size_t File::println	(	unsigned char	c,
		int	print_type = DEC
	)

ファイルに数値を書き込み、改行コード(\n\r)を書き込む

引数

[in]	c	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::println	(	int	val,
		int	print_type = DEC
	)

ファイルに数値を書き込み、改行コード(\n\r)を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::println	(	unsigned int	val,
		int	print_type = DEC
	)

ファイルに数値を書き込み、改行コード(\n\r)を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::println	(	long	val,
		int	print_type = DEC
	)

ファイルに数値を書き込み、改行コード(\n\r)を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::println	(	unsigned long	val,
		int	print_type = DEC
	)

ファイルに数値を書き込み、改行コード(\n\r)を書き込む

引数

[in]	val	書き込みたい数値
	print_type	基数 2: 二進数 8: 8進数 10: 10進数 (デフォルト) 16: 16進数

戻り値

実際に出力したバイト数

size_t File::println	(	double	val,
		int	fpdigit = 2
	)

ファイルに浮動小数点数を書き込み、改行コード(\n\r)を書き込む

引数

[in]	val	書き込みたい数値
	fpdigit	桁数

戻り値

実際に出力したバイト数

size_t File::println

(

void

)

改行コードのみ出力する

引数

なし

戻り値

実際に出力したバイト数

unsigned long File::size

(

)

ファイルのサイズを調べる

戻り値

ファイルのサイズ(バイト単位)

char* File::name

(

)

開いているファイルの名前を調べる

この関数はディレクトリ検索の結果として使うとよい。ファイル名は8.3形式。

警告

この関数が返す文字列はライブラリがメモリを確保し、管理しているため、ユーザプログラムではfreeしてはならない。

戻り値

ファイル名を表す文字列

bool File::isDirectory

(

)

開いているファイルオブジェクトが、ファイルか、ディレクトリかを調べる

戻り値

ディレクトリならばtrueを返す。ファイルならばfalseを返す。

File File::openNextFile

(

)

ディレクトリオブジェクトの場合、次のファイルオブジェクトを返す

戻り値

次に該当するファイルオブジェクト。該当がなければfalseとして評価されるファイルオブジェクトを返す。

void File::rewindDirectory

(

)

ディレクトリの検索を最初に戻す

戻り値

なし