分享
JKBase 文件操作模块(JFile)API 文档
输入“/”快速插入内容
JKBase 文件操作模块(JFile)API 文档
用户3521
用户3521
4月1日修改
概述
模块名称:JFile
命名空间:
JKBase
头文件:
J:/JKBase/Include/JFile.h
导入库:
J:/JKBase/Library/$(Platform)/JFile.lib
动态库:
J:/JKBase/Library/$(Platform)/JFile.dll
用途:提供文件与文件夹的常用操作,包括打开/关闭、存在判断、创建、路径解析、读写(追加/覆盖/日期日志)、加密/解密、删除文件夹、枚举文件夹内文件等。
说明:
$(Platform)
为编译平台占位符,实际使用时替换为
x86
或
x64
。
1.
版本信息
JFile_Version_Info
代码块
C++
JFILE_API PCSTR JFile_Version_Info();
•
描述:获取当前 JFile 模块的版本号。
•
参数:无。
•
返回值:版本字符串,格式为
"****-YYYYMMDD"
。
2.
文件打开与关闭
JFile_Open / JFile_Close
代码块
C++
JFILE_API FILE* JFile_Open(PCSTR File_Name, PCSTR Mode);
JFILE_API int JFile_Close(FILE* File_Ptr);
•
描述:打开或关闭文件。
JFile_Open
与标准 C 库
fopen
行为一致;
JFile_Close
与
fclose
行为一致。
•
参数:
◦
File_Name
:文件全路径。
◦
Mode
:打开模式(如
"r"
、
"w"
、
"a"
等)。
◦
File_Ptr
:由
JFile_Open
返回的文件指针。
•
返回值:
◦
JFile_Open
成功返回文件指针,失败返回
NULL
。
◦
JFile_Close
成功返回 0,失败返回
EOF
。
3.
存在判断
JFile_Check_File_Exist
代码块
C++
JFILE_API bool JFile_Check_File_Exist(PCSTR File_Path);
•
描述:判断指定文件是否存在。
•
参数:
◦
File_Path
:文件全路径(需要扩展名,如
"D:/file.doc"
)。
•
返回值:存在返回
true
,否则
false
。
JFile_Check_Folder_Exist
代码块
C++
JFILE_API bool JFile_Check_Folder_Exist(PCSTR Folder_Path);
•
描述:判断指定文件夹是否存在。
•
参数:
◦
Folder_Path
:文件夹路径(支持
"D:/folder"
、
"D:/folder/"
、
"D:\\folder"
、
"D:\\folder\\"
等形式)。
•
返回值:存在返回
true
,否则
false
。
4.
创建文件夹与文件
JFile_Create_Folder
代码块
C++
JFILE_API bool JFile_Create_Folder(PCSTR Folder_Path);
•
描述:创建文件夹路径(支持多级目录)。如果文件夹已存在,也返回
true
。
•
参数:
◦
Folder_Path
:文件夹路径(支持多种分隔符格式)。
•
返回值:已存在或创建成功返回
true
,创建失败返回
false
。
JFile_Create_File
代码块
C++
JFILE_API bool JFile_Create_File(PCSTR File_Full_Path);
•
描述:创建文件(不写入内容)。如果文件所在目录不存在,会先创建目录。如果文件已存在,返回
true
。
•
参数:
◦
File_Full_Path
:文件完整路径。