Falcon::VFSProvider::VFSProvider::CParams Class Reference

Create Paramenter. More...

#include <vfsprovider.h>

Inheritance diagram for Falcon::VFSProvider::VFSProvider::CParams:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 CParams ()
uint32 createMode () const
CParamscreateMode (uint32 cm)
bool isNoOvr () const
bool isNoStream () const
CParamsnoOvr ()
 Fail if the file exists.
CParamsnoStream ()
 Avoid returning an open stream to the caller.

Friends

class VFSProvider


Detailed Description

Create Paramenter.

Parameters for creating a file on the provider. Subclasses may overload this class to provide VFS specific create-flags.

Note that the "create" operation is also entitled to create a directory on the VFS, if the appropriate flag is set.

The class is used for variable parameters idiom in the VFSProvider::create() method.

Read/write and share modes are inherited from open settings.


Constructor & Destructor Documentation

Falcon::VFSProvider::VFSProvider::CParams::CParams (  )  [inline]


Member Function Documentation

uint32 Falcon::VFSProvider::VFSProvider::CParams::createMode (  )  const [inline]

CParams& Falcon::VFSProvider::VFSProvider::CParams::createMode ( uint32  cm  )  [inline]

bool Falcon::VFSProvider::VFSProvider::CParams::isNoOvr (  )  const [inline]

bool Falcon::VFSProvider::VFSProvider::CParams::isNoStream (  )  const [inline]

CParams& Falcon::VFSProvider::VFSProvider::CParams::noOvr (  )  [inline]

Fail if the file exists.

If the file exists and none of append() or truncate() options are specified, the operation fails.

The subsystem is bound to return a nonzero value from getLastFsError() if returning faulty from a this operation.

CParams& Falcon::VFSProvider::VFSProvider::CParams::noStream (  )  [inline]

Avoid returning an open stream to the caller.

Usually, if create() is successful an open stream is returned. Conversely, if this flag is set, the create function will return 0, eventually closing immediately the handle to the file in those systems with "open creating" semantics.


Friends And Related Function Documentation

friend class VFSProvider [friend]


The documentation for this class was generated from the following file:

Generated on Mon Oct 19 10:11:49 2009 for Falcon_Core by  doxygen 1.5.8