Open Game Engine 2D API
 全部 函数 变量
函数
File

函数

int OGE_FileSize (string sFileName)
 取得一个文件的大小
bool OGE_FileExists (string sFileName)
 检查文件是否存在
bool OGE_CreateEmptyFile (string sFileName)
 创建一个空文件
bool OGE_RemoveFile (string sFileName)
 删除一个文件
int OGE_OpenFile (string sFileName, bool bTryCreate)
 打开一个文件
int OGE_CloseFile (int iFileId)
 关闭一个文件
int OGE_SaveFile (int iFileId)
 保存文件的修改
bool OGE_GetFileEof (int iFileId)
 检查是否已经到达文件的末端
int OGE_GetFileReadPos (int iFileId)
 取得文件当前的读取位置
int OGE_SetFileReadPos (int iFileId, int iPos)
 设置文件当前的读取位置
int OGE_SetFileReadPosFromEnd (int iFileId, int iPos)
 通过设置与文件末端的相对位置来设定文件当前的读取位置
int OGE_GetFileWritePos (int iFileId)
 取得文件当前的写入位置
int OGE_SetFileWritePos (int iFileId, int iPos)
 设置文件当前的写入位置
int OGE_SetFileWritePosFromEnd (int iFileId, int iPos)
 通过设置与文件末端的相对位置来设定文件当前的写入位置
char OGE_ReadFileByte (int iFileId)
 从文件中读取一个字节
int OGE_ReadFileInt (int iFileId)
 从文件中读取一个整数
double OGE_ReadFileFloat (int iFileId)
 从文件中读取一个浮点数
int OGE_ReadFileBuf (int iFileId, int iLen, int iBufId)
 从文件中拷贝一段内容(若干字节)到一个缓冲区中
string OGE_ReadFileStr (int iFileId, int iLen)
 从文件中读取一个字符串
int OGE_WriteFileByte (int iFileId, char value)
 往文件中写入一个字节
int OGE_WriteFileInt (int iFileId, int value)
 往文件中写入一个整数
int OGE_WriteFileFloat (int iFileId, double value)
 往文件中写入一个浮点数
int OGE_WriteFileBuf (int iFileId, int buf, int len)
 从缓冲区中拷贝一段内容(若干字节)到文件中
int OGE_WriteFileStr (int iFileId, string value)
 往文件中写入一个字符串

函数文档

int OGE_CloseFile ( int  iFileId)

关闭一个文件

参数:
[in]iFileId文件的ID
返回:
如果成功则返回一个非负数
bool OGE_CreateEmptyFile ( string  sFileName)

创建一个空文件

参数:
[in]sFileName文件的路径
返回:
是否创建成功
bool OGE_FileExists ( string  sFileName)

检查文件是否存在

参数:
[in]sFileName文件路径
返回:
如果文件存在则返回真,否则返回假
int OGE_FileSize ( string  sFileName)

取得一个文件的大小

参数:
[in]sFileName文件的路径
返回:
文件的大小
bool OGE_GetFileEof ( int  iFileId)

检查是否已经到达文件的末端

参数:
[in]iFileId文件的ID
返回:
是否到达末端
int OGE_GetFileReadPos ( int  iFileId)

取得文件当前的读取位置

参数:
[in]iFileId文件的ID
返回:
当前的读取位置
int OGE_GetFileWritePos ( int  iFileId)

取得文件当前的写入位置

参数:
[in]iFileId文件的ID
返回:
当前的写入位置
int OGE_OpenFile ( string  sFileName,
bool  bTryCreate 
)

打开一个文件

参数:
[in]sFileName文件路径
[in]bTryCreate如果文件不存在,是否创建新文件
返回:
文件的ID
int OGE_ReadFileBuf ( int  iFileId,
int  iLen,
int  iBufId 
)

从文件中拷贝一段内容(若干字节)到一个缓冲区中

参数:
[in]iFileId文件的ID
[in]iLen要拷贝的字节数
[in]iBufId目标缓冲区的ID
返回:
如果成功则返回一个非零数
char OGE_ReadFileByte ( int  iFileId)

从文件中读取一个字节

参数:
[in]iFileId文件的ID
返回:
字节的值
double OGE_ReadFileFloat ( int  iFileId)

从文件中读取一个浮点数

参数:
[in]iFileId文件的ID
返回:
浮点数的值
int OGE_ReadFileInt ( int  iFileId)

从文件中读取一个整数

参数:
[in]iFileId文件的ID
返回:
整数的值
string OGE_ReadFileStr ( int  iFileId,
int  iLen 
)

从文件中读取一个字符串

参数:
[in]iFileId文件的ID
[in]iLen要读取的字符串的长度
返回:
所读到的字符串
bool OGE_RemoveFile ( string  sFileName)

删除一个文件

参数:
[in]sFileName文件的路径
返回:
是否删除成功
int OGE_SaveFile ( int  iFileId)

保存文件的修改

参数:
[in]iFileId文件的ID
返回:
如果成功则返回一个非负数
int OGE_SetFileReadPos ( int  iFileId,
int  iPos 
)

设置文件当前的读取位置

参数:
[in]iFileId文件的ID
[in]iPos读取位置
返回:
当前的读取位置
int OGE_SetFileReadPosFromEnd ( int  iFileId,
int  iPos 
)

通过设置与文件末端的相对位置来设定文件当前的读取位置

参数:
[in]iFileId文件的ID
[in]iPos与文件末端的距离
返回:
文件当前的读取位置
int OGE_SetFileWritePos ( int  iFileId,
int  iPos 
)

设置文件当前的写入位置

参数:
[in]iFileId文件的ID
[in]iPos写入位置
返回:
当前的写入位置
int OGE_SetFileWritePosFromEnd ( int  iFileId,
int  iPos 
)

通过设置与文件末端的相对位置来设定文件当前的写入位置

参数:
[in]iFileId文件的ID
[in]iPos与文件末端的距离
返回:
文件当前的写入位置
int OGE_WriteFileBuf ( int  iFileId,
int  buf,
int  len 
)

从缓冲区中拷贝一段内容(若干字节)到文件中

参数:
[in]iFileId文件的ID
[in]buf源缓冲区的ID
[in]len要拷贝的字节数
返回:
如果成功则返回一个非负数
int OGE_WriteFileByte ( int  iFileId,
char  value 
)

往文件中写入一个字节

参数:
[in]iFileId文件的ID
[in]value字节的值
返回:
如果成功则返回一个非负数
int OGE_WriteFileFloat ( int  iFileId,
double  value 
)

往文件中写入一个浮点数

参数:
[in]iFileId文件的ID
[in]value浮点数的值
返回:
如果成功则返回一个非负数
int OGE_WriteFileInt ( int  iFileId,
int  value 
)

往文件中写入一个整数

参数:
[in]iFileId文件的ID
[in]value整数的值
返回:
如果成功则返回一个非负数
int OGE_WriteFileStr ( int  iFileId,
string  value 
)

往文件中写入一个字符串

参数:
[in]iFileId文件的ID
[in]value要写入的字符串
返回:
如果成功则返回一个非负数