hgl::FileStream类参考

文件流操作类 更多...

#include <FileStream.H>

继承图，类hgl::FileStream

所有成员的列表。

公有成员
	FileStream ()
	FileStream (void *)
	~FileStream ()
bool	Create (const wchar_t *)
bool	Open (const wchar_t *, FileOpenMode=fomOpenRead)
void	Close ()
int64	Seek (int64, SeekOrigin=soBegin)
保护成员
int64	GetPosition ()
void	SetPosition (int64)
int64	GetSize ()
void	SetSize (int64)
bool	GetCanSeek ()
bool	GetCanRead ()
bool	GetCanWrite ()
void	InitPrivate ()
int64	_Read (void *, int64)
int64	_Write (const void *, int64)
友元
class	PartFileStream

---

详细描述

文件流操作类

FileStream是一个针对文件的流式访问类，它从Stream类派生

---

构造及析构函数文档

hgl::FileStream::FileStream

(

)

hgl::FileStream::FileStream

(

void *

fileheader

)

本类构造函数

hgl::FileStream::~FileStream

(

)

---

成员函数文档

int64 hgl::FileStream::_Read	(	void *	buf,
		int64	bufsize
	)		[protected, virtual]

从文件流中读取指取数据

参数:

buf	保存读出数据的缓冲区
bufsize	缓冲区长度

返回:

>=0 读出的数据长度

-1 读取失败

实现了hgl::Stream。

int64 hgl::FileStream::_Write	(	const void *	buf,
		int64	bufsize
	)		[protected, virtual]

向文件流中写入数据

参数:

buf	要写入的数据
bufsize	要写入的数据长度

返回:

>=0 成功写入的数据长度

-1 写入失败

实现了hgl::Stream。

void hgl::FileStream::Close

(

)

关闭文件

bool hgl::FileStream::Create

(

const wchar_t *

fn

)

创建一个文件

参数:

fn

文件名

返回:

创建文件是否成功

bool hgl::FileStream::GetCanRead

(

)

[inline, protected, virtual]

实现了hgl::Stream。

bool hgl::FileStream::GetCanSeek

(

)

[inline, protected, virtual]

实现了hgl::Stream。

bool hgl::FileStream::GetCanWrite

(

)

[inline, protected, virtual]

实现了hgl::Stream。

int64 hgl::FileStream::GetPosition

(

)

[protected]

int64 hgl::FileStream::GetSize

(

)

[protected]

void hgl::FileStream::InitPrivate

(

)

[protected]

bool hgl::FileStream::Open	(	const wchar_t *	fn,
		FileOpenMode	fom = fomOpenRead
	)

根据指定文件名和模式打开一个文件

参数:

fn	文件名
fom	文件打开模式，见::FileOpenMode枚举

返回:

打开文件是否成功

int64 hgl::FileStream::Seek	(	int64	offset,
		SeekOrigin	so = soBegin
	)		[virtual]

移动流读取或写入的当前位置

参数:

offset	移动的偏移量
so	移动的方法

返回:

移动后的位置

参见:

SeekOrigin

重载hgl::Stream。

void hgl::FileStream::SetPosition

(

int64

pos

)

[protected]

void hgl::FileStream::SetSize

(

int64

)

[protected]

---

友元及相关函数文档

friend class PartFileStream [friend]

---

该类的文档由以下文件生成：

• K:/CMGDKv18/SDK/Include/hgl/stream/FileStream.H
• K:/CMGDKv18/SDK/Source/Base/Stream/FileStream.CPP