Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

DWFCore::DWFStandardFileDescriptor Class Reference
[Platform-specific Class and Function Declarations]

#include "dwfcore/win32/StandardFileDescriptor.h"

Inheritance diagram for DWFCore::DWFStandardFileDescriptor:

Inheritance graph
[legend]
Collaboration diagram for DWFCore::DWFStandardFileDescriptor:

Collaboration graph
[legend]
List of all members.

Detailed Description

Descriptor implementing file access and control using the Win32 System API.
Since:
1.0.1.

Definition at line 45 of file ansi/StandardFileDescriptor.h.

Public Member Functions

_DWFCORE_API DWFStandardFileDescriptor (DWFFile &rFile, int eIOFlags, int eIOMode) throw ()
_DWFCORE_API DWFStandardFileDescriptor (DWFFile &rFile, int iHandle) throw ()
virtual _DWFCORE_API ~DWFStandardFileDescriptor () throw ()
_DWFCORE_API void open () throw ( DWFException )
_DWFCORE_API void close () throw ( DWFException )
_DWFCORE_API size_t size () throw ( DWFException )
_DWFCORE_API size_t read (void *pBuffer, size_t nBytesToRead) throw ( DWFException )
_DWFCORE_API off_t seek (int eOrigin, off_t nOffset) throw ( DWFException )
_DWFCORE_API size_t write (const void *pBuffer, size_t nBytesToWrite) throw ( DWFException )
_DWFCORE_API void flush ()
_DWFCORE_API DWFStandardFileDescriptor (DWFFile &rFile, DWORD dwDesiredAccess, DWORD dwShareMode, LPSECURITY_ATTRIBUTES pSecurityAttributes, DWORD dwCreationDisposition, DWORD dwFlagsAndAttributes) throw ()
_DWFCORE_API DWFStandardFileDescriptor (DWFFile &rFile, HANDLE hFile) throw ()
virtual _DWFCORE_API ~DWFStandardFileDescriptor () throw ()
_DWFCORE_API void open () throw ( DWFException )
_DWFCORE_API void close () throw ( DWFException )
_DWFCORE_API size_t size () throw ( DWFException )
_DWFCORE_API size_t read (void *pBuffer, size_t nBytesToRead) throw ( DWFException )
_DWFCORE_API off_t seek (int eOrigin, off_t nOffset) throw ( DWFException )
_DWFCORE_API size_t write (const void *pBuffer, size_t nBytesToWrite) throw ( DWFException )
_DWFCORE_API void flush ()


Constructor & Destructor Documentation

_DWFCORE_API DWFCore::DWFStandardFileDescriptor::DWFStandardFileDescriptor DWFFile rFile,
int  eIOFlags,
int  eIOMode
throw ()
 

Constructor

This constructor uses the open() function.

Parameters:
rFile The file on which this descriptor will operate.
eIOFlags Flag or combination of flags indicating how the file will be accessible.
eIOMode Specifies the permissions to use when creating a new file.
Exceptions:
None 

_DWFCORE_API DWFCore::DWFStandardFileDescriptor::DWFStandardFileDescriptor DWFFile rFile,
int  iHandle
throw ()
 

Constructor

This constructor consumes a file handle/descriptor identifier.

Parameters:
rFile The file on which this descriptor will operate.
iHandle The handle.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFStandardFileDescriptor::~DWFStandardFileDescriptor  )  throw () [virtual]
 

Destructor

Exceptions:
None 

_DWFCORE_API DWFCore::DWFStandardFileDescriptor::DWFStandardFileDescriptor DWFFile rFile,
DWORD  dwDesiredAccess,
DWORD  dwShareMode,
LPSECURITY_ATTRIBUTES  pSecurityAttributes,
DWORD  dwCreationDisposition,
DWORD  dwFlagsAndAttributes
throw ()
 

Constructor

This constructor uses the Microsoft Windows API CreateFile() function.

Parameters:
rFile The file on which this descriptor will operate.
dwDesiredAccess Please refer to Microsoft documentation for CreateFile().
dwShareMode Please refer to Microsoft documentation for CreateFile().
pSecurityAttributes Please refer to Microsoft documentation for CreateFile().
dwCreationDisposition Please refer to Microsoft documentation for CreateFile().
dwFlagsAndAttributes Please refer to Microsoft documentation for CreateFile().
Exceptions:
None 

_DWFCORE_API DWFCore::DWFStandardFileDescriptor::DWFStandardFileDescriptor DWFFile rFile,
HANDLE  hFile
throw ()
 

Constructor

This constructor consumes a Win32 HANDLE data structure.

Parameters:
rFile The file on which this descriptor will operate.
hFile The handle.
Exceptions:
None 

virtual _DWFCORE_API DWFCore::DWFStandardFileDescriptor::~DWFStandardFileDescriptor  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::close  )  throw ( DWFException ) [virtual]
 

Performs a close operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::close  )  throw ( DWFException ) [virtual]
 

Performs a close operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::flush  )  [inline, virtual]
 

Performs a flush operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

Definition at line 179 of file win32/StandardFileDescriptor.h.

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::flush  )  [inline, virtual]
 

Performs a flush operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

Definition at line 161 of file ansi/StandardFileDescriptor.h.

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::open  )  throw ( DWFException ) [virtual]
 

Performs an open operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API void DWFCore::DWFStandardFileDescriptor::open  )  throw ( DWFException ) [virtual]
 

Performs an open operation on the associated file within the context of the descriptor implementation.

Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::read void *  pBuffer,
size_t  nBytesToRead
throw ( DWFException ) [virtual]
 

Performs a read operation on the associated file within the context of the descriptor implementation.

Parameters:
pBuffer A pointer to a block of memory to receive the bytes. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToRead The number of bytes to copy into pBuffer. This value should not exceed the capacity of the memory block at pBuffer.
Returns:
The number of actual bytes read.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::read void *  pBuffer,
size_t  nBytesToRead
throw ( DWFException ) [virtual]
 

Performs a read operation on the associated file within the context of the descriptor implementation.

Parameters:
pBuffer A pointer to a block of memory to receive the bytes. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToRead The number of bytes to copy into pBuffer. This value should not exceed the capacity of the memory block at pBuffer.
Returns:
The number of actual bytes read.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

_DWFCORE_API off_t DWFCore::DWFStandardFileDescriptor::seek int  eOrigin,
off_t  nOffset
throw ( DWFException ) [virtual]
 

Performs a seek operation on the associated file within the context of the descriptor implementation.

Parameters:
eOrigin One of SEEK_SET, SEEK_CUR or SEEK_END.
nOffset The number of bytes from eOrigin to move the internal cursor.
Returns:
The previous cursor offset before the seek.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

_DWFCORE_API off_t DWFCore::DWFStandardFileDescriptor::seek int  eOrigin,
off_t  nOffset
throw ( DWFException ) [virtual]
 

Performs a seek operation on the associated file within the context of the descriptor implementation.

Parameters:
eOrigin One of SEEK_SET, SEEK_CUR or SEEK_END.
nOffset The number of bytes from eOrigin to move the internal cursor.
Returns:
The previous cursor offset before the seek.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::size  )  throw ( DWFException ) [virtual]
 

Returns the size of the associated file, in bytes, within the context of the descriptor implementation.

Returns:
The size of the file, in bytes.
Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::size  )  throw ( DWFException ) [virtual]
 

Returns the size of the associated file, in bytes, within the context of the descriptor implementation.

Returns:
The size of the file, in bytes.
Exceptions:
DWFException 

Implements DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::write const void *  pBuffer,
size_t  nBytesToWrite
throw ( DWFException ) [virtual]
 

Performs a write operation on the associated file within the context of the descriptor implementation.

Parameters:
pBuffer A pointer to a block of memory whose data will be written into the stream. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToWrite The number of bytes to copy from pBuffer.
Returns:
The number of bytes actually written.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.

_DWFCORE_API size_t DWFCore::DWFStandardFileDescriptor::write const void *  pBuffer,
size_t  nBytesToWrite
throw ( DWFException ) [virtual]
 

Performs a write operation on the associated file within the context of the descriptor implementation.

Parameters:
pBuffer A pointer to a block of memory whose data will be written into the stream. Any implementation receiving a NULL buffer pointer should throw a DWFInvalidArgumentException.
nBytesToWrite The number of bytes to copy from pBuffer.
Returns:
The number of bytes actually written.
Exceptions:
DWFException 

Reimplemented from DWFCore::DWFFileDescriptor.


The documentation for this class was generated from the following files:
Generated on Tue May 17 12:05:26 2005 for Autodesk DWF Core Library by  doxygen 1.4.1