Home > Article > Backend Development > Complete collection of C language file operation functions (super detailed)
fopen (open file)
Related functions open, fclose
Header file
#includeade979de5fc0e1ca0540f360a64c230b
Define function FILE * fopen(const char * path,const char *
mode);
Function description
The parameter path string contains the path and file name of the file to be opened, and the parameter mode string represents the flow shape.
mode has the following types of strings:
r
Opens a read-only file, which must exist.
r+ opens a file that can be read and written. The file must exist.
w
Open a write-only file. If the file exists, the file length will be cleared to 0, that is, the file content will disappear. If the file does not exist, create the file.
w+
Open a readable and writable file. If the file exists, the file length will be cleared to zero, that is, the file content will disappear. If the file does not exist, create the file.
a
Open a write-only file in append mode. If the file does not exist, the file will be created. If the file exists, the written data will be added to the end of the file, that is, the original content of the file will be retained.
a+
Opens a file for reading and writing in append mode. If the file does not exist, the file will be created. If the file exists, the written data will be added to the end of the file, that is, the original content of the file will be retained.
r Open text file for reading. The stream is positioned at the beginning of the file. r+ Open for reading and writing. The stream is positioned at the beginning of the file. w Truncate file to zero length or create text file for writing. The stream is positioned at the beginning of the file. w+ Open for reading and writing. The file is created if it does not exist, otherwise it is truncated. The stream is posi‐ tioned at the beginning of the file. a Open for appending (writing at end of file). The file is created if it does not exist. The stream is positioned at the end of the file. a+ Open for reading and appending (writing at end of file). The file is created if it does not exist. The initial file posi‐ tion for reading is at the beginning of the file, but output is always appended to the end of the file.
The above morphological strings can be added with a b character, such as rb, w+b or ab+ and other combinations, add b
The character is used to tell the function library that the file being opened is a binary file, not a plain text file. However, in POSIX systems, including Linux, this character will be ignored. The new file created by fopen() will have S_IRUSR|S_IWUSR|S_IRGRP|S_IWGRP|S_IROTH|S_IWOTH (0666) permissions. This file permission will also refer to the umask value.
Return value
After the file is successfully opened, the file pointer pointing to the stream will be returned. If the file opening fails, NULL is returned and the error code is stored in errno.
Additional Notes
Generally speaking, after opening a file, some file reading or writing operations will be performed. If the file opening fails, the subsequent reading and writing operations will not proceed smoothly, so please make error judgment and processing after fopen().
Example
#include<stdio.h> main() { FILE * fp; fp=fopen(“noexist”,”a+”); if(fp= =NULL) return; fclose(fp); }
1.
fprintf
Function: transfer formatted output to a file
Header file: #includeade979de5fc0e1ca0540f360a64c230b
Function prototype: int
fprintf(FILE *stream, char *format[, argument,...]);
FILE*
A FILE type pointer
char* formatted input function, the same format as in printf
Return value: Returns the number of bytes converted on success, returns a negative number on failure
fp =
fopen("/local/test.c","a+");
fprintf(fp,"%sn",str);
2.
fscanf
Function: Perform formatted input from a stream
Header file: #includeade979de5fc0e1ca0540f360a64c230b
Function prototype: int
fscanf(FILE *stream, char *format[,argument...]);
FILE* a FILE type pointer
char*
Formatted output function, the same format as in scanf
Return value: Returns the number of bytes converted on success, returns a negative number on failure
fp =
fopen("/local/test.c","a+");
fscanf(fp,"%s",str);
3. clearerr (clear the error flag of the file stream)
Related functions
feof
Header file #includeade979de5fc0e1ca0540f360a64c230b
Define function void clearerr(FILE *
stream);
Function description
clearerr() clears the error flag used by the file stream specified by the parameter stream.
Return value
4.fclose (close file)
Related functions
close, fflush, fopen, setbuf
Header file #includeade979de5fc0e1ca0540f360a64c230b
Define function int
fclose(FILE * stream);
Function description
fclose() is used to close the file previously opened by fopen(). This action will cause the data in the buffer to be written to the file and release the file resources provided by the system.
Return value
If the file closing action is successful, 0 is returned. If an error occurs, EOF is returned and the error code is stored in errno.
Error code EBADF indicates that the parameter stream is not an open file.
Example
Please refer to fopen().
5.fdopen (convert file descriptor to file pointer)
Related functions
fopen, open, fclose
Header file #includeade979de5fc0e1ca0540f360a64c230b
Define function FILE * fdopen(int
fildes, const char * mode);
Function description fdopen() will convert the parameter fildes
The file descriptor is converted into the corresponding file pointer and returned. The parameter mode string represents the stream form of the file pointer, which must be the same as the original file descriptor reading and writing mode. About mode
Please refer to fopen() for string format.
Return value Returns the file pointer pointing to the stream when the conversion is successful. On failure, NULL is returned and the error code is stored in errno.
Example
#include<stdio.h> main() { FILE * fp =fdopen(0,”w+”); fprintf(fp,”%s/n”,”hello!”); fclose(fp); } 执行 hello!
6.feof(检查文件流是否读到了文件尾)
相关函数
fopen,fgetc,fgets,fread
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int feof(FILE *
stream);
函数说明
feof()用来侦测是否读取到了文件尾,尾数stream为fopen()所返回之文件指针。如果已到文件尾则返回非零值,其他情况返回0。
返回值
返回非零值代表已到达文件尾。
7.fflush(更新缓冲区)
相关函数
write,fopen,fclose,setbuf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int
fflush(FILE* stream);
函数说明
fflush()会强迫将缓冲区内的数据写回参数stream指定的文件中。如果参数stream为NULL,fflush()会将所有打开的文件数据更新。
返回值
成功返回0,失败返回EOF,错误代码存于errno中。
错误代码 EBADF 参数stream
指定的文件未被打开,或打开状态为只读。其它错误代码参考write()。
8.fgetc(由文件中读取一个字符)
相关函数
open,fread,fscanf,getc
表头文件 includeade979de5fc0e1ca0540f360a64c230b
定义函数 nt fgetc(FILE *
stream);
函数说明 fgetc()从参数stream所指的文件中读取一个字符。若读到文件尾而无数据时便返回EOF。
返回值
getc()会返回读取到的字符,若返回EOF则表示到了文件尾。
范例
#include<stdio.h> main() { FILE *fp; int c; fp=fopen(“exist”,”r”); while((c=fgetc(fp))!=EOF) printf(“%c”,c); fclose(fp); }
9.fgets(由文件中读取一字符串)
相关函数
open,fread,fscanf,getc
表头文件 includeade979de5fc0e1ca0540f360a64c230b
定义函数 har * fgets(char *
s,int size,FILE * stream);
函数说明
fgets()用来从参数stream所指的文件内读入字符并存到参数s所指的内存空间,直到出现换行字符、读到文件尾或是已读了size-1个字符为止,最后会加上NULL作为字符串结束。
返回值
gets()若成功则返回s指针,返回NULL则表示有错误发生。
范例
#include<stdio.h> main() { char s[80]; fputs(fgets(s,80,stdin),stdout); } 执行 this is a test /*输入*/ this is a test /*输出*/
10.fileno(返回文件流所使用的文件描述词)
相关函数
open,fopen
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int fileno(FILE *
stream);
函数说明 fileno()用来取得参数stream指定的文件流所使用的文件描述词。
返回值
返回文件描述词。
范例
#include<stdio.h> main() { FILE * fp; int fd; fp=fopen(“/etc/passwd”,”r”); fd=fileno(fp); printf(“fd=%d/n”,fd); fclose(fp); } 执行 fd=3
12.fputc(将一指定字符写入文件流中)
相关函数
fopen,fwrite,fscanf,putc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int fputc(int
c,FILE * stream);
函数说明 fputc 会将参数c 转为unsigned char 后写入参数stream 指定的文件中。
返回值
fputc()会返回写入成功的字符,即参数c。若返回EOF则代表写入失败。
范例
#include<stdio.h> main() { FILE * fp; char a[26]=”abcdefghijklmnopqrstuvwxyz”; int i; fp= fopen(“noexist”,”w”); for(i=0;i<26;i++) fputc(a,fp); fclose(fp); }
13.fputs(将一指定的字符串写入文件内)
相关函数
fopen,fwrite,fscanf,fputc,putc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int
fputs(const char * s,FILE * stream);
函数说明
fputs()用来将参数s所指的字符串写入到参数stream所指的文件内。
返回值
若成功则返回写出的字符个数,返回EOF则表示有错误发生。
范例
请参考fgets()。
fread(从文件流读取数据)
相关函数
fopen,fwrite,fseek,fscanf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 size_t
fread(void * ptr,size_t size,size_t nmemb,FILE * stream);
函数说明
fread()用来从文件流中读取数据。参数stream为已打开的文件指针,参数ptr
指向欲存放读取进来的数据空间,读取的字符数以参数size*nmemb来决定。Fread()会返回实际读取到的nmemb数目,如果此值比参数nmemb
来得小,则代表可能读到了文件尾或有错误发生,这时必须用feof()或ferror()来决定发生什么情况。
返回值
返回实际读取到的nmemb数目。
附加说明
范例
#include<stdio.h> #define nmemb 3 struct test { char name[20]; int size; }s[nmemb]; int main(){ FILE * stream; int i; stream = fopen(“/tmp/fwrite”,”r”); fread(s,sizeof(struct test),nmemb,stream); fclose(stream); for(i=0;i<nmemb;i++) printf(“name[%d]=%-20s:size[%d]=%d/n”,i,s.name,i,s.size); } 执行 name[0]=Linux! size[0]=6 name[1]=FreeBSD! size[1]=8 name[2]=Windows2000 size[2]=11
14.freopen(打开文件)
相关函数
fopen,fclose
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 FILE * freopen(const char *
path,const char * mode,FILE * stream);
函数说明
参数path字符串包含欲打开的文件路径及文件名,参数mode请参考fopen()说明。参数stream为已打开的文件指针。Freopen()会将原stream所打开的文件流关闭,然后打开参数path的文件。
返回值
文件顺利打开后,指向该流的文件指针就会被返回。如果文件打开失败则返回NULL,并把错误代码存在errno 中。
范例
#include<stdio.h> main() { FILE * fp; fp=fopen(“/etc/passwd”,”r”); fp=freopen(“/etc/group”,”r”,fp); fclose(fp); }
15.fseek(移动文件流的读写位置)
相关函数
rewind,ftell,fgetpos,fsetpos,lseek
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int
fseek(FILE * stream,long offset,int whence);
函数说明
fseek()用来移动文件流的读写位置。参数stream为已打开的文件指针,参数offset为根据参数whence来移动读写位置的位移数。
参数
whence为下列其中一种:
SEEK_SET从距文件开头offset位移量为新的读写位置。SEEK_CUR
以目前的读写位置往后增加offset个位移量。
SEEK_END将读写位置指向文件尾后再增加offset个位移量。
当whence值为SEEK_CUR
或SEEK_END时,参数offset允许负值的出现。
下列是较特别的使用方式:
1) 欲将读写位置移动到文件开头时:fseek(FILE *stream,0,SEEK_SET);
2)
欲将读写位置移动到文件尾时:fseek(FILE *stream,0,0SEEK_END);
返回值
当调用成功时则返回0,若有错误则返回-1,errno会存放错误代码。
附加说明
fseek()不像lseek()会返回读写位置,因此必须使用ftell()来取得目前读写的位置。
范例
#include<stdio.h> main() { FILE * stream; long offset; fpos_t pos; stream=fopen(“/etc/passwd”,”r”); fseek(stream,5,SEEK_SET); printf(“offset=%d/n”,ftell(stream)); rewind(stream); fgetpos(stream,&pos); printf(“offset=%d/n”,pos); pos=10; fsetpos(stream,&pos); printf(“offset = %d/n”,ftell(stream)); fclose(stream); } 执行 offset = 5 offset =0 offset=10
16.ftell(取得文件流的读取位置)
相关函数
fseek,rewind,fgetpos,fsetpos
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 long
ftell(FILE * stream);
函数说明 ftell()用来取得文件流目前的读写位置。参数stream为已打开的文件指针。
返回值
当调用成功时则返回目前的读写位置,若有错误则返回-1,errno会存放错误代码。
错误代码 EBADF
参数stream无效或可移动读写位置的文件流。
范例 参考fseek()。
17.fwrite(将数据写至文件流)
相关函数
fopen,fread,fseek,fscanf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 size_t
fwrite(const void * ptr,size_t size,size_t nmemb,FILE * stream);
函数说明
fwrite()用来将数据写入文件流中。参数stream为已打开的文件指针,参数ptr
指向欲写入的数据地址,总共写入的字符数以参数size*nmemb来决定。Fwrite()会返回实际写入的nmemb数目。
返回值
返回实际写入的nmemb数目。
范例
#include<stdio.h> #define set_s (x,y) {strcoy(s[x].name,y);s[x].size=strlen(y);} #define nmemb 3 struct test { char name[20]; int size; }s[nmemb]; main() { FILE * stream; set_s(0,”Linux!”); set_s(1,”FreeBSD!”); set_s(2,”Windows2000.”); stream=fopen(“/tmp/fwrite”,”w”); fwrite(s,sizeof(struct test),nmemb,stream); fclose(stream); } 执行 参考fread()。
18.getc(由文件中读取一个字符)
相关函数
read,fopen,fread,fgetc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int getc(FILE *
stream);
函数说明
getc()用来从参数stream所指的文件中读取一个字符。若读到文件尾而无数据时便返回EOF。虽然getc()与fgetc()作用相同,但getc()为宏定义,非真正的函数调用。
返回值
getc()会返回读取到的字符,若返回EOF则表示到了文件尾。
范例
参考fgetc()。
19.getchar(由标准输入设备内读进一字符)
相关函数
fopen,fread,fscanf,getc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int
getchar(void);
函数说明 getchar()用来从标准输入设备中读取一个字符。然后将该字符从unsigned
char转换成int后返回。
返回值 getchar()会返回读取到的字符,若返回EOF则表示有错误发生。
附加说明
getchar()非真正函数,而是getc(stdin)宏定义。
范例
#include<stdio.h> main() { FILE * fp; int c,i; for(i=0li<5;i++) { c=getchar(); putchar(c); } } 执行 1234 /*输入*/ 1234 /*输出*/
20.gets(由标准输入设备内读进一字符串)
相关函数
fopen,fread,fscanf,fgets
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 char *
gets(char *s);
函数说明
gets()用来从标准设备读入字符并存到参数s所指的内存空间,直到出现换行字符或读到文件尾为止,最后加上NULL作为字符串结束。
返回值
gets()若成功则返回s指针,返回NULL则表示有错误发生。
附加说明
由于gets()无法知道字符串s的大小,必须遇到换行字符或文件尾才会结束输入,因此容易造成缓冲溢出的安全性问题。建议使用fgets()取代。
范例
参考fgets()
21.mktemp(产生唯一的临时文件名)
相关函数
tmpfile
表头文件 #include8e359799bdf1a571032ba13cc96acda9
定义函数 char * mktemp(char *
template);
函数说明
mktemp()用来产生唯一的临时文件名。参数template所指的文件名称字符串中最后六个字符必须是XXXXXX。产生后的文件名会借字符串指针返回。
返回值
文件顺利打开后,指向该流的文件指针就会被返回。如果文件打开失败则返回NULL,并把错误代码存在errno中。
附加说明 参数template所指的文件名称字符串必须声明为数组,如:
char template[ ]=”template-XXXXXX”;
不可用char
* template=”template-XXXXXX”;
范例
#include<stdlib.h> main() { char template[ ]=”template-XXXXXX”; mktemp(template); printf(“template=%s/n”,template); }
22.putc(将一指定字符写入文件中)
相关函数
fopen,fwrite,fscanf,fputc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int putc(int
c,FILE * stream);
函数说明 putc()会将参数c转为unsigned
char后写入参数stream指定的文件中。虽然putc()与fputc()作用相同,但putc()为宏定义,非真正的函数调用。
返回值
putc()会返回写入成功的字符,即参数c。若返回EOF则代表写入失败。
范例
参考fputc()。
23.putchar(将指定的字符写到标准输出设备)
相关函数
fopen,fwrite,fscanf,fputc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int putchar
(int c);
函数说明 putchar()用来将参数c字符写到标准输出设备。
返回值
putchar()会返回输出成功的字符,即参数c。若返回EOF则代表输出失败。
附加说明
putchar()非真正函数,而是putc(c,stdout)宏定义。
范例
参考getchar()。
24.rewind(重设文件流的读写位置为文件开头)
相关函数
fseek,ftell,fgetpos,fsetpos
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 void
rewind(FILE * stream);
函数说明
rewind()用来把文件流的读写位置移至文件开头。参数stream为已打开的文件指针。此函数相当于调用fseek(stream,0,SEEK_SET)。
返回值
范例
参考fseek()
25.setbuf(设置文件流的缓冲区)
相关函数
setbuffer,setlinebuf,setvbuf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 void
setbuf(FILE * stream,char * buf);
函数说明
在打开文件流后,读取内容之前,调用setbuf()可以用来设置文件流的缓冲区。参数stream为指定的文件流,参数buf指向自定的缓冲区起始地址。如果参数buf为NULL指针,则为无缓冲IO。Setbuf()相当于调用:setvbuf(stream,buf,buf?_IOFBF:_IONBF,BUFSIZ)
返回值
26.setbuffer(设置文件流的缓冲区)
相关函数
setlinebuf,setbuf,setvbuf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 void
setbuffer(FILE * stream,char * buf,size_t size);
函数说明
在打开文件流后,读取内容之前,调用setbuffer()可用来设置文件流的缓冲区。参数stream为指定的文件流,参数buf指向自定的缓冲区起始地址,参数size为缓冲区大小。
返回值
27.setlinebuf(设置文件流为线性缓冲区)
相关函数
setbuffer,setbuf,setvbuf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 void
setlinebuf(FILE * stream);
函数说明
setlinebuf()用来设置文件流以换行为依据的无缓冲IO。相当于调用:setvbuf(stream,(char *
)NULL,_IOLBF,0);请参考setvbuf()。
返回值
28.setvbuf(设置文件流的缓冲区)
相关函数
setbuffer,setlinebuf,setbuf
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int
setvbuf(FILE * stream,char * buf,int mode,size_t size);
函数说明
在打开文件流后,读取内容之前,调用setvbuf()可以用来设置文件流的缓冲区。参数stream为指定的文件流,参数buf指向自定的缓冲区起始地址,参数size为缓冲区大小,参数mode有下列几种
_IONBF
无缓冲IO
_IOLBF 以换行为依据的无缓冲IO
_IOFBF
完全无缓冲IO。如果参数buf为NULL指针,则为无缓冲IO。
返回值
29.ungetc(将指定字符写回文件流中)
相关函数
fputc,getchar,getc
表头文件 #includeade979de5fc0e1ca0540f360a64c230b
定义函数 int ungetc(int c,FILE
* stream);
函数说明
ungetc()将参数c字符写回参数stream所指定的文件流。这个写回的字符会由下一个读取文件流的函数取得。
返回值 成功则返回c
字符,若有错误则返回EOF。
#include <stdio.h> #include <stdlib.h> int main() { FILE *fp = NULL; char* str; char re; int num = 10; str = (char*)malloc(100); //snprintf(str, 10,"test: %s", "0123456789012345678"); // printf("str=%s\n", str); fp = fopen("/local/test.c","a+"); if (fp==NULL){ printf("Fail to open file\n"); } // fseek(fp,-1,SEEK_END); num = ftell(fp); printf("test file long:%d\n",num); fscanf(fp,"%s",str); printf("str = %s\n",str); printf("test a: %s\n",str); while ((re=getc(fp))!=EOF){//getc可以用作fgetc用 printf("%c",re); } //fread(str,10,10,fp); fgets(str,100,fp); printf("test a: %s\n",str); sprintf(str,"xiewei test is:%s", "ABCDEFGHIGKMNI"); printf("str2=%s\n", str); // fprintf(fp,"%s\n",str); fwrite(str,2,10,fp); num = ftell(fp); if(str!=NULL){ free(str); } fclose(fp); return 0; }