sl@0: // Copyright (c) 1998-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: #include "UT_STD.H"
sl@0: 
sl@0: EXPORT_C void RStoreReadStream::OpenL(const CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens and prepares an existing stream for reading. The function leaves if it 
sl@0: cannot complete successfully.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream with the specified 
sl@0: stream id.
sl@0: @param anId The stream id of the stream to be read. */
sl@0: 	{
sl@0: 	if (anId==KNullStreamId)
sl@0: 		__LEAVE(KErrNotFound);
sl@0: 	RReadStream::Attach(aStore.DoReadL(anId));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreReadStream::OpenLC(const CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens and prepares an existing stream for reading, leaving a cleanup item on 
sl@0: the cleanup stack. The function leaves if it cannot complete successfully.
sl@0: 
sl@0: Placing a cleanup item for the RStoreReadStream onto the cleanup stack allows 
sl@0: allocated resources to be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream with the specified 
sl@0: id.
sl@0: @param anId The stream id of the stream to be read. */
sl@0: 	{
sl@0: 	OpenL(aStore,anId);
sl@0: 	PushL();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TStreamId RStoreWriteStream::CreateL(CStreamStore& aStore)
sl@0: /** Creates a new stream.
sl@0: 
sl@0: The function creates a new stream in the specified store and prepares the 
sl@0: stream for writing. The function returns the new stream id, and leaves if 
sl@0: it cannot complete successfully.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store which is to contain the new stream.
sl@0: @return The stream id of the newly created stream.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL() */
sl@0: 	{
sl@0: 	TStreamId id;
sl@0: 	RWriteStream::Attach(aStore.DoCreateL(id));
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TStreamId RStoreWriteStream::CreateLC(CStreamStore& aStore)
sl@0: /** Creates a new stream, putting a cleanup item onto the cleanup stack.
sl@0: 
sl@0: The function creates a new stream in the specified store and prepares the 
sl@0: stream for writing. The function returns the new stream id, and leaves if 
sl@0: it cannot complete successfully.
sl@0: 
sl@0: Putting a cleanup item onto the cleanup stack allows allocated resources to 
sl@0: be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store which is to contain the new stream.
sl@0: @return The stream id of the newly created stream.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL() */
sl@0: 	{
sl@0: 	TStreamId id=CreateL(aStore);
sl@0: 	PushL();
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::OpenL(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream and prepares it for overwriting.
sl@0: 
sl@0: The function leaves if cannot complete successfully.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be overwritten.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore */
sl@0: 	{
sl@0: 	if (anId==KNullStreamId)
sl@0: 		__LEAVE(KErrNotFound);
sl@0: 	RWriteStream::Attach(aStore.DoWriteL(anId));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::OpenLC(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream, prepares it for overwriting, and puts a cleanup item 
sl@0: onto the cleanup stack.
sl@0: 
sl@0: The function leaves if cannot complete successfully.
sl@0: 
sl@0: Putting a cleanup item onto the cleanup stack allows allocated resources to 
sl@0: be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be overwritten.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore */
sl@0: 	{
sl@0: 	OpenL(aStore,anId);
sl@0: 	PushL();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::ReplaceL(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream and prepares it for replacement.
sl@0: 
sl@0: The function leaves if it cannot complete successfully.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be replaced.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore */
sl@0: 	{
sl@0: 	if (anId==KNullStreamId)
sl@0: 		__LEAVE(KErrNotFound);
sl@0: 	RWriteStream::Attach(aStore.DoReplaceL(anId));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::ReplaceLC(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream, prepares it for replacement and puts a cleanup item 
sl@0: onto the cleanup stack.
sl@0: 
sl@0: The function leaves if it cannot complete successfully.
sl@0: 
sl@0: Placing a cleanup item onto the cleanup stack allows allocated resources to 
sl@0: be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be replaced.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore */
sl@0: 	{
sl@0: 	ReplaceL(aStore,anId);
sl@0: 	PushL();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::AppendL(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream and prepares it for appending.
sl@0: 
sl@0: The function leaves if it cannot complete successfully.
sl@0: 
sl@0: Note that a call to this function must be matched by a call to CommitL() before 
sl@0: this object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be appended.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore
sl@0: @see CPermanentFileStore */
sl@0: 	{
sl@0: 	AppendLC(aStore,anId);
sl@0: 	CleanupStack::Pop();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStoreWriteStream::AppendLC(CStreamStore& aStore,TStreamId anId)
sl@0: /** Opens an existing stream, prepares it for appending, and puts a cleanup item 
sl@0: onto the cleanup stack. 
sl@0: 
sl@0: The function leaves if it cannot complete successfully.
sl@0: 
sl@0: Putting a cleanup item onto the cleanup stack allows allocated resources to 
sl@0: be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: Note that call to this function must be matched by a call to CommitL() before 
sl@0: the RStoreWriteStream object is disposed of.
sl@0: 
sl@0: @param aStore A reference to the store containing the stream.
sl@0: @param anId The id of the stream to be appended.
sl@0: @see RWriteStream::Release()
sl@0: @see RWriteStream::CommitL()
sl@0: @see CDirectFileStore
sl@0: @see CPermanentFileStore */
sl@0: 	{
sl@0: 	OpenLC(aStore,anId);
sl@0: 	Sink()->SeekL(MStreamBuf::EWrite,EStreamEnd);
sl@0: 	}
sl@0: