CMGDK r49-rc2
组合类型 | 公有成员 | 保护成员 | 友元
hgl::HAC类参考

HAC-3包裹文件支持类 更多...

#include <HAC.H>

继承图,类hgl::HAC
hgl::Thread hgl::ThreadMutex hgl::HacTemplate< Hac3File > hgl::HacMapping hgl::HacTemplate< F > hgl::HAC3

所有成员的列表。

组合类型

struct  HacLoadItem

公有成员

 HAC ()
 本类构造函数
virtual ~HAC ()
 本类析构函数
virtual bool FindFile (const wchar_t *filename)=0
 查找一个文件
virtual StreamLoadFile (const wchar_t *filename, bool load_to_memory=false)=0
 加载一个文件到流
virtual bool LoadFile (const wchar_t *filename, void **data, int *size)=0
 加载一个文件到指定内存块
virtual void * GetFolder (const wchar_t *pathname)=0
 取得一个目录
virtual int GetFileCount (void *path_pointer)=0
 取得目录下的文件数量
virtual bool GetFileInfo (void *path_pointer, int index, WideString &name, int &size)=0
 取得文件信息
virtual void * GetFile (void *path_pointer, const wchar_t *filename, int *filelength=0)=0
virtual void * GetFile (const wchar_t *filename, int *filelength=0)=0
virtual bool FindFile (void *path_pointer, const wchar_t *filename)=0
 查找一个文件
virtual StreamLoadFileFrom (void *path_pointer, const wchar_t *filename, bool load_to_memory=false)=0
 加载一个文件到流
virtual bool LoadFileFrom (void *path_pointer, const wchar_t *filename, void **data, int *size)=0
 加载一个文件到指定内存块
void * LoadAcquire (const wchar_t *filename, void *data=0, int start=0, int length=0)
void * LoadAcquire (void *path_pointer, const wchar_t *filename, void *data=0, int start=0, int length=0)
void * LoadAcquire (void *file_pointer, void *data=0, int start=0, int length=0)
HacStatus GetStatus (void *)
int GetSize (void *)
void * GetData (void *)
void Clear (void *)
void Clear ()

保护成员

void CloseThread ()

友元

HACOpenHAC (const wchar_t *)
 打开一个.HAC文件,或是根据路径创建一个虚拟的HAC环境

详细描述

HAC-3包裹文件支持类

HAC包裹文件支持类,可以设定一个子目录以HAC方式访问,用以方便开发。
在制作发行版时直接将整个目录打包为.HAC即可.
另外,它不支持HAC-2的HAC文件。


构造及析构函数文档

hgl::HAC::HAC ( )

本类构造函数

hgl::HAC::~HAC ( ) [virtual]

本类析构函数


成员函数文档

void hgl::HAC::Clear ( void *  file_pointer)

清除文件

参数:
file_pointer文件访问指针
void hgl::HAC::Clear ( )

清除所有正在加载的文件

void hgl::HAC::CloseThread ( ) [protected]
virtual bool hgl::HAC::FindFile ( const wchar_t *  filename) [pure virtual]

查找一个文件

查找一个文件,确定其是否存在

参数:
filename要查找的文件名称
返回:
文件是否存在

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual bool hgl::HAC::FindFile ( void *  path_pointer,
const wchar_t *  filename 
) [pure virtual]

查找一个文件

查找一个文件,确定其是否存在

参数:
path_pointer目录指针
filename要查找的文件名称
返回:
文件是否存在

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

void * hgl::HAC::GetData ( void *  file_pointer)

取得一个文件的数据(如果读取完成的话)

参数:
file_pointer文件访问指针
返回:
数据指针,如果未完成返回NULL
virtual void* hgl::HAC::GetFile ( void *  path_pointer,
const wchar_t *  filename,
int filelength = 0 
) [pure virtual]

在指定目录内取得一个文件

参数:
path_pointer目录指针
filename文件名
返回:
文件指针

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual void* hgl::HAC::GetFile ( const wchar_t *  filename,
int filelength = 0 
) [pure virtual]

取得一个文件

参数:
filename文件名
返回:
文件指针

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual int hgl::HAC::GetFileCount ( void *  path_pointer) [pure virtual]

取得目录下的文件数量

取得目录内的文件数量

参数:
path_pointer目录指针
返回:
文件数量

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual bool hgl::HAC::GetFileInfo ( void *  path_pointer,
int  index,
WideString name,
int size 
) [pure virtual]

取得文件信息

取得目录内指定的第index个文件的信息

参数:
path_pointer目录指针
index要取的文件索引
name取出的文件名
size取出的文件长度
返回:
是否成功

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual void* hgl::HAC::GetFolder ( const wchar_t *  pathname) [pure virtual]

取得一个目录

取得一个目录

参数:
pathname目录名称
返回:
目录指针,返回NULL表示失败

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

int hgl::HAC::GetSize ( void *  file_pointer)

取得一个请求的数据长度

参数:
file_pointer文件访问指针
HacStatus hgl::HAC::GetStatus ( void *  file_pointer)

取得一个文件读取的现有状态

参数:
file_pointer文件访问指针
返回:
状态
void* hgl::HAC::LoadAcquire ( void *  file_pointer,
void *  data = 0,
int  start = 0,
int  length = 0 
) [inline]

异步请求读取一个文件的指定部分到内存

参数:
file_pointer要加载的文件指针
data加载后数据存放地址
start要加载数据在文件中的起始地址
length要加载数据的长度
返回:
文件访问指针
参数:
length异步请求取一个文件
void* hgl::HAC::LoadAcquire ( void *  path_pointer,
const wchar_t *  filename,
void *  data = 0,
int  start = 0,
int  length = 0 
) [inline]

异步请求读取一个文件的指定部分到内存

参数:
path_pointer目录指针
filename要加载的文件名称
data加载后数据存放地址
start要加载数据在文件中的起始地址
length要加载数据的长度
返回:
文件访问指针
参数:
length异步请求取一个文件
void* hgl::HAC::LoadAcquire ( const wchar_t *  filename,
void *  data = 0,
int  start = 0,
int  length = 0 
) [inline]

异步请求读取一个文件的指定部分到内存

参数:
filename要加载的文件名称
data加载后数据存放地址
start要加载数据在文件中的起始地址
length要加载数据的长度
返回:
文件访问指针
参数:
length异步请求取一个文件
virtual Stream* hgl::HAC::LoadFile ( const wchar_t *  filename,
bool  load_to_memory = false 
) [pure virtual]

加载一个文件到流

加载一个文件到流中,并返回这个流

参数:
filename要加载的文件名称
load_to_memory是否加载到内存
返回:
保存文件数据的流,如果加载失败返回NULL

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual bool hgl::HAC::LoadFile ( const wchar_t *  filename,
void **  data,
int size 
) [pure virtual]

加载一个文件到指定内存块

加载一个文件到内存中

参数:
filename要加载的文件名称
data要用来保存数据的内存块
size内存块的大小,以及加载成功后文件的大小
返回:
是否加载成功

hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual bool hgl::HAC::LoadFileFrom ( void *  path_pointer,
const wchar_t *  filename,
void **  data,
int size 
) [pure virtual]

加载一个文件到指定内存块

加载一个文件到内存中

参数:
path_pointer目录指针
filename要加载的文件名称
data要用来保存数据的内存块
size内存块的大小,以及加载成功后文件的大小
返回:
是否加载成功

hgl::HAC3hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。

virtual Stream* hgl::HAC::LoadFileFrom ( void *  path_pointer,
const wchar_t *  filename,
bool  load_to_memory = false 
) [pure virtual]

加载一个文件到流

加载一个文件到流中,并返回这个流

参数:
path_pointer目录指针
filename要加载的文件名称
load_to_memory是否加载到内存
返回:
保存文件数据的流,如果加载失败返回NULL

hgl::HAC3hgl::HacMappinghgl::HacTemplate< F >hgl::HacTemplate< Hac3File >内被实现。


友元及相关函数文档

HAC* OpenHAC ( const wchar_t *  filename) [friend]

打开一个.HAC文件,或是根据路径创建一个虚拟的HAC环境

打开一个.Hac文件或是指定一个目录,创建并返回一个HAC3包裹文件支持类。请注意它支持HAC-3的.HAC文件,并不支持HAC-2的HAC文件

参数:
filename包裹文件名称或是目录名称
返回:
HAC3包裹文件支持类,返回NULL表示失败

该类的文档由以下文件生成:
 全部  名字空间 文件 函数 变量 类型定义 枚举 枚举值 友元 宏定义