sl@0: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #ifndef __S32FILEITER_H__
sl@0: #define __S32FILEITER_H__
sl@0: 
sl@0: #ifndef __S32STD_H__
sl@0: #include <s32std.h>
sl@0: #endif
sl@0: 
sl@0: //Forward declarations
sl@0: class CPermanentFileStore;
sl@0: class RPermanentStoreTocIter;
sl@0: 
sl@0: /**
sl@0: This class describes an object that can serve as a stream ID forward iterator
sl@0: for the controlled sequence of stream IDs in CPermanentFileStore instance.
sl@0: RPermanentFileStoreIter instances will allow you to access only stream IDs which are
sl@0: already commited to the store.
sl@0: 
sl@0: Usage pattern:
sl@0: @code
sl@0: CPermanentFileStore* store;
sl@0: //create "store" ...
sl@0: RPermanentFileStoreIter iter;
sl@0: iter.ResetLC(*store);
sl@0: TStreamId id;
sl@0: while((id = iter.NextL()) != KNullStreamIdValue)
sl@0: 	{
sl@0: 	RStoreReadStream in;
sl@0: 	in.OpenLC(*store, id);
sl@0: 	//read from "in" stream
sl@0: 	CleanupStack::PopAndDestroy(&in);
sl@0: 	}
sl@0: CleanupStack::PopAndDestroy(&iter);
sl@0: @endcode
sl@0: 
sl@0: Any change (deleting/adding streams) of stream IDs sequence during the lifetime of 
sl@0: RPermanentFileStoreIter instance will invalidate it.
sl@0: 
sl@0: @internalTechnology
sl@0: @released
sl@0: @see CPermanentFileStore
sl@0: @see TStreamId
sl@0: */
sl@0: class RPermanentFileStoreIter
sl@0: 	{
sl@0: 
sl@0: public:
sl@0: 	inline RPermanentFileStoreIter();
sl@0: 	IMPORT_C void Close();
sl@0: 	IMPORT_C void ResetLC(const CPermanentFileStore& aStore);
sl@0: 	inline void ResetL(const CPermanentFileStore& aStore);
sl@0: 	IMPORT_C TStreamId NextL();
sl@0: 
sl@0: private:
sl@0: 	RPermanentStoreTocIter* iImpl;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #include <s32fileiter.inl>
sl@0: 
sl@0: #endif//__S32FILEITER_H__