1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/persistentstorage/store/INC/S32FileIter.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,75 @@
     1.4 +// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __S32FILEITER_H__
    1.20 +#define __S32FILEITER_H__
    1.21 +
    1.22 +#ifndef __S32STD_H__
    1.23 +#include <s32std.h>
    1.24 +#endif
    1.25 +
    1.26 +//Forward declarations
    1.27 +class CPermanentFileStore;
    1.28 +class RPermanentStoreTocIter;
    1.29 +
    1.30 +/**
    1.31 +This class describes an object that can serve as a stream ID forward iterator
    1.32 +for the controlled sequence of stream IDs in CPermanentFileStore instance.
    1.33 +RPermanentFileStoreIter instances will allow you to access only stream IDs which are
    1.34 +already commited to the store.
    1.35 +
    1.36 +Usage pattern:
    1.37 +@code
    1.38 +CPermanentFileStore* store;
    1.39 +//create "store" ...
    1.40 +RPermanentFileStoreIter iter;
    1.41 +iter.ResetLC(*store);
    1.42 +TStreamId id;
    1.43 +while((id = iter.NextL()) != KNullStreamIdValue)
    1.44 +	{
    1.45 +	RStoreReadStream in;
    1.46 +	in.OpenLC(*store, id);
    1.47 +	//read from "in" stream
    1.48 +	CleanupStack::PopAndDestroy(&in);
    1.49 +	}
    1.50 +CleanupStack::PopAndDestroy(&iter);
    1.51 +@endcode
    1.52 +
    1.53 +Any change (deleting/adding streams) of stream IDs sequence during the lifetime of 
    1.54 +RPermanentFileStoreIter instance will invalidate it.
    1.55 +
    1.56 +@internalTechnology
    1.57 +@released
    1.58 +@see CPermanentFileStore
    1.59 +@see TStreamId
    1.60 +*/
    1.61 +class RPermanentFileStoreIter
    1.62 +	{
    1.63 +
    1.64 +public:
    1.65 +	inline RPermanentFileStoreIter();
    1.66 +	IMPORT_C void Close();
    1.67 +	IMPORT_C void ResetLC(const CPermanentFileStore& aStore);
    1.68 +	inline void ResetL(const CPermanentFileStore& aStore);
    1.69 +	IMPORT_C TStreamId NextL();
    1.70 +
    1.71 +private:
    1.72 +	RPermanentStoreTocIter* iImpl;
    1.73 +
    1.74 +	};
    1.75 +
    1.76 +#include <s32fileiter.inl>
    1.77 +
    1.78 +#endif//__S32FILEITER_H__