DX::IDXFile Struct Reference

#include <IDXFile.h>

Inherits DX::IDXUserData, and DX::IDXFileSystemOwned.

Inherited by DX::IDXFileFloat32, DX::IDXFileInt32, and DX::IDXFileResource.

Collaboration diagram for DX::IDXFile:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual const wchar_t *DXMCALL GetFilename () const =0
virtual DXFileType DXMCALL GetType () const =0
virtual uint DXMCALL GetLength () const =0
virtual DXError DXMCALL Get (ByteArray out) const =0
virtual DXError DXMCALL Get (uint index, BytePtr out) const =0
virtual DXError DXMCALL Get (uint start, uint count, ByteArray out) const =0
virtual DXError DXMCALL SetFilename (const wchar_t *filename)=0
virtual void DXMCALL Clear ()=0


Detailed Description

Base class for all files.

Member Function Documentation

virtual void DXMCALL DX::IDXFile::Clear (  )  [pure virtual]

Remove any data in this file.

virtual DXError DXMCALL DX::IDXFile::Get ( uint  start,
uint  count,
ByteArray  out 
) const [pure virtual]

Get a chunk of bytes.

Parameters:
start The index of the first byte to retrieve.
count The number of bytes to retrieve.
out A user allocated array of bytes of length at least count.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if start was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFile::Get ( uint  index,
BytePtr  out 
) const [pure virtual]

Get the byte at the specified index.

Parameters:
index The index of the byte to retrieve.
out A pointer to a byte to receive the result.
Returns:
Error_NullParam if out was null.
Error_OutOfRange if index was out of range.
Error_Success if the result was stored in out.

virtual DXError DXMCALL DX::IDXFile::Get ( ByteArray  out  )  const [pure virtual]

Get all the data in this file.

Parameters:
out A pointer to a user allocated array of bytes, equal to GetLength.
Returns:
Error_NullParam if out was null.
Error_Success if the result was stored in out.

virtual const wchar_t* DXMCALL DX::IDXFile::GetFilename (  )  const [pure virtual]

Get the filename of this file.

Returns:
A wchar_t* which is the filename.

virtual uint DXMCALL DX::IDXFile::GetLength (  )  const [pure virtual]

Get the number of bytes in the file.

Returns:
The number of bytes.

virtual DXFileType DXMCALL DX::IDXFile::GetType (  )  const [pure virtual]

Get the type of this file.

Returns:
A member of the FileType enumeration.

virtual DXError DXMCALL DX::IDXFile::SetFilename ( const wchar_t *  filename  )  [pure virtual]

Set the filename that this file uses.

Parameters:
filename A wchar_t* to use as the filename.


Generated on Wed Jun 17 17:24:50 2009 for DXMesh API by  doxygen 1.5.7.1