| class CDirectFileStore : public CFileStore |
Direct file store.
A direct file store implements a subset of the operations defined by the store abstract framework. Direct file stores allow streams to be created and objects externalised to them however once the streams have been committed and closed, they cannot subsequently be changed, i.e. streams cannot be replaced, deleted, extended or changed in any way.
| Public Member Functions | |
|---|---|
| CDirectFileStore(RFile &) | |
| CDirectFileStore(RFileBuf &, const TUidType &) | |
| CDirectFileStore * | CreateL(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | CreateLC(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | FromL(RFile &) |
| CDirectFileStore * | FromLC(RFile &) |
| IMPORT_C TUid | Layout() |
| CDirectFileStore * | NewL(RFile &) |
| CDirectFileStore * | NewLC(RFile &) |
| CDirectFileStore * | OpenL(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | OpenLC(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | ReplaceL(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | ReplaceLC(RFs &, const TDesC &, TUint) |
| CDirectFileStore * | TempL(RFs &, const TDesC &, TFileName &, TUint) |
| CDirectFileStore * | TempLC(RFs &, const TDesC &, TFileName &, TUint) |
| Protected Member Functions | |
|---|---|
| IMPORT_C MStreamBuf * | DoCreateL(TStreamId &) |
| IMPORT_C MStreamBuf * | DoReadL(TStreamId) |
| Private Member Functions | |
|---|---|
| IMPORT_C CFileStore * | DoNewL(RFile &) |
| IMPORT_C void | DoSetRootL(TStreamId) |
| IMPORT_C void | ExternalizeL(RWriteStream &) |
| IMPORT_C void | InternalizeL(RReadStream &) |
| Inherited Attributes | |
|---|---|
| CPersistentStore::iRoot | |
| IMPORT_C | CDirectFileStore | ( | RFileBuf & | aBuf, |
| const TUidType & | aType | |||
| ) | ||||
| CDirectFileStore * | CreateL | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a new file and constructs a new direct file store object to be associated with this file.
A pointer to the new direct file store object
| CDirectFileStore * | CreateLC | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a new file and constructs a new direct file store object to be associated with this file, and places the pointer onto the cleanup stack.
A pointer to the new direct file store object
| IMPORT_C MStreamBuf * | DoCreateL | ( | TStreamId & | anId | ) | [protected, virtual] |
Creates a new stream in the store. The function gets the allocated stream id in the anId parameter. A stream buffer for the stream should be returned, ready to write into the new stream. This provides the implementation for the RStoreWriteStream::CreateL() functions.
The stream buffer to be written to.
| TStreamId & anId | On return, contains the allocated stream id. |
| IMPORT_C MStreamBuf * | DoReadL | ( | TStreamId | anId | ) | const [protected, virtual] |
Opens the requested stream for reading. The function should return a stream buffer positioned at the beginning of this stream.
This function is called by the OpenL() and OpenLC() member functions of RStoreReadStream.
A stream buffer positioned at the beginning of the stream to be read.
| TStreamId anId | The stream to be read. |
| IMPORT_C void | DoSetRootL | ( | TStreamId | anId | ) | [private, virtual] |
| TStreamId anId |
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream | ) | const [private, virtual] |
| RWriteStream & aStream |
| CDirectFileStore * | FromL | ( | RFile & | aFile | ) | [static, inline] |
Constructs a direct file store object from an already opened file.
The file must already be open before calling this function.
Note that ownership of the file passes to the store. The referenced RFile is cleared and is no longer valid.
A pointer to the new direct file store object.
| RFile & aFile | A reference to the opened file. |
| CDirectFileStore * | FromLC | ( | RFile & | aFile | ) | [static, inline] |
Constructs a direct file store object from an already opened file, and places the pointer onto the cleanup stack.
The file must already be open before calling this function.
Note that ownership of the file passes to the store. The referenced RFile is cleared and is no longer valid.
A pointer to the new direct file store object.
| RFile & aFile | A reference to the opened file. |
| IMPORT_C void | InternalizeL | ( | RReadStream & | aStream | ) | [private, virtual] |
| RReadStream & aStream |
| IMPORT_C TUid | Layout | ( | ) | const [virtual] |
Gets the UID that uniquely identifies the specific type of this file store.
This function must be defined and implemented by classes derived from CFileStore. The direct file store, CDirectFileStore and the permanent file store, CPermanentFileStore both implement suitable functions.
The UID that uniquely identifies the specific type of file store.
| CDirectFileStore * | NewL | ( | RFile & | aFile | ) | [static, inline] |
Constructs a new direct file store object in an already opened file.
The file must already be open before calling the function. The existing content of the file is discarded.
Note that ownership of the file passes to the store. The referenced RFile is cleared and is no longer valid:
A pointer to the new direct file store object.
| RFile & aFile | A reference to the opened file. |
| CDirectFileStore * | NewLC | ( | RFile & | aFile | ) | [static, inline] |
Constructs a new direct file store object in an already opened file and places the pointer onto the cleanup stack.
The file must already be open before calling the function. The existing content of the file is discarded.
Note that ownership of the file passes to the store. The referenced RFile is cleared and is no longer valid:
A pointer to the new direct file store object.
| RFile & aFile | A reference to the opened file. |
| CDirectFileStore * | OpenL | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Opens a file containing a direct file store, and constructs a direct file store object.
A pointer to the new direct file store object.
| CDirectFileStore * | OpenLC | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Opens a file containing a direct file store, constructs a direct file store object, and places the pointer onto the cleanup stack.
A pointer to the new direct file store object.
| CDirectFileStore * | ReplaceL | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a file and constructs a direct file store object to be associated with it.
The file replaces any existing file of the same name.
A pointer to the new direct file store object.
| CDirectFileStore * | ReplaceLC | ( | RFs & | aFs, |
| const TDesC & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a file, constructs a direct file store object to be associated with it, and places the pointer onto the cleanup stack.
The file replaces any existing file of the same name.
A pointer to the new direct file store object.
| CDirectFileStore * | TempL | ( | RFs & | aFs, |
| const TDesC & | aPath, | |||
| TFileName & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a temporary file and constructs a direct file store object to be associated with it.
The new file is created in the specified path and a unique file name is generated by the file server.
Note that the store framework does not delete a temporary file after it is closed.
A pointer to the new direct file store object.
| CDirectFileStore * | TempLC | ( | RFs & | aFs, |
| const TDesC & | aPath, | |||
| TFileName & | aName, | |||
| TUint | aFileMode | |||
| ) | [static, inline] | |||
Creates a temporary file, constructs a direct file store object to be associated with it, and places the pointer onto the cleanup stack.
The new file is created in the specified path and a unique file name is generated by the file server.
Note that the store framework does not delete a temporary file after it is closed.
A pointer to the new direct file store object.