1 // Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
18 EXPORT_C void RStoreReadStream::OpenL(const CStreamStore& aStore,TStreamId anId)
19 /** Opens and prepares an existing stream for reading. The function leaves if it
20 cannot complete successfully.
22 @param aStore A reference to the store containing the stream with the specified
24 @param anId The stream id of the stream to be read. */
26 if (anId==KNullStreamId)
27 __LEAVE(KErrNotFound);
28 RReadStream::Attach(aStore.DoReadL(anId));
31 EXPORT_C void RStoreReadStream::OpenLC(const CStreamStore& aStore,TStreamId anId)
32 /** Opens and prepares an existing stream for reading, leaving a cleanup item on
33 the cleanup stack. The function leaves if it cannot complete successfully.
35 Placing a cleanup item for the RStoreReadStream onto the cleanup stack allows
36 allocated resources to be cleaned up if a subsequent leave occurs.
38 @param aStore A reference to the store containing the stream with the specified
40 @param anId The stream id of the stream to be read. */
46 EXPORT_C TStreamId RStoreWriteStream::CreateL(CStreamStore& aStore)
47 /** Creates a new stream.
49 The function creates a new stream in the specified store and prepares the
50 stream for writing. The function returns the new stream id, and leaves if
51 it cannot complete successfully.
53 Note that a call to this function must be matched by a call to CommitL() before
54 this object is disposed of.
56 @param aStore A reference to the store which is to contain the new stream.
57 @return The stream id of the newly created stream.
58 @see RWriteStream::Release()
59 @see RWriteStream::CommitL() */
62 RWriteStream::Attach(aStore.DoCreateL(id));
66 EXPORT_C TStreamId RStoreWriteStream::CreateLC(CStreamStore& aStore)
67 /** Creates a new stream, putting a cleanup item onto the cleanup stack.
69 The function creates a new stream in the specified store and prepares the
70 stream for writing. The function returns the new stream id, and leaves if
71 it cannot complete successfully.
73 Putting a cleanup item onto the cleanup stack allows allocated resources to
74 be cleaned up if a subsequent leave occurs.
76 Note that a call to this function must be matched by a call to CommitL() before
77 this object is disposed of.
79 @param aStore A reference to the store which is to contain the new stream.
80 @return The stream id of the newly created stream.
81 @see RWriteStream::Release()
82 @see RWriteStream::CommitL() */
84 TStreamId id=CreateL(aStore);
89 EXPORT_C void RStoreWriteStream::OpenL(CStreamStore& aStore,TStreamId anId)
90 /** Opens an existing stream and prepares it for overwriting.
92 The function leaves if cannot complete successfully.
94 Note that a call to this function must be matched by a call to CommitL() before
95 this object is disposed of.
97 @param aStore A reference to the store containing the stream.
98 @param anId The id of the stream to be overwritten.
99 @see RWriteStream::Release()
100 @see RWriteStream::CommitL()
101 @see CDirectFileStore */
103 if (anId==KNullStreamId)
104 __LEAVE(KErrNotFound);
105 RWriteStream::Attach(aStore.DoWriteL(anId));
108 EXPORT_C void RStoreWriteStream::OpenLC(CStreamStore& aStore,TStreamId anId)
109 /** Opens an existing stream, prepares it for overwriting, and puts a cleanup item
110 onto the cleanup stack.
112 The function leaves if cannot complete successfully.
114 Putting a cleanup item onto the cleanup stack allows allocated resources to
115 be cleaned up if a subsequent leave occurs.
117 Note that a call to this function must be matched by a call to CommitL() before
118 this object is disposed of.
120 @param aStore A reference to the store containing the stream.
121 @param anId The id of the stream to be overwritten.
122 @see RWriteStream::Release()
123 @see RWriteStream::CommitL()
124 @see CDirectFileStore */
130 EXPORT_C void RStoreWriteStream::ReplaceL(CStreamStore& aStore,TStreamId anId)
131 /** Opens an existing stream and prepares it for replacement.
133 The function leaves if it cannot complete successfully.
135 Note that a call to this function must be matched by a call to CommitL() before
136 this object is disposed of.
138 @param aStore A reference to the store containing the stream.
139 @param anId The id of the stream to be replaced.
140 @see RWriteStream::Release()
141 @see RWriteStream::CommitL()
142 @see CDirectFileStore */
144 if (anId==KNullStreamId)
145 __LEAVE(KErrNotFound);
146 RWriteStream::Attach(aStore.DoReplaceL(anId));
149 EXPORT_C void RStoreWriteStream::ReplaceLC(CStreamStore& aStore,TStreamId anId)
150 /** Opens an existing stream, prepares it for replacement and puts a cleanup item
151 onto the cleanup stack.
153 The function leaves if it cannot complete successfully.
155 Placing a cleanup item onto the cleanup stack allows allocated resources to
156 be cleaned up if a subsequent leave occurs.
158 Note that a call to this function must be matched by a call to CommitL() before
159 this object is disposed of.
161 @param aStore A reference to the store containing the stream.
162 @param anId The id of the stream to be replaced.
163 @see RWriteStream::Release()
164 @see RWriteStream::CommitL()
165 @see CDirectFileStore */
167 ReplaceL(aStore,anId);
171 EXPORT_C void RStoreWriteStream::AppendL(CStreamStore& aStore,TStreamId anId)
172 /** Opens an existing stream and prepares it for appending.
174 The function leaves if it cannot complete successfully.
176 Note that a call to this function must be matched by a call to CommitL() before
177 this object is disposed of.
179 @param aStore A reference to the store containing the stream.
180 @param anId The id of the stream to be appended.
181 @see RWriteStream::Release()
182 @see RWriteStream::CommitL()
183 @see CDirectFileStore
184 @see CPermanentFileStore */
186 AppendLC(aStore,anId);
190 EXPORT_C void RStoreWriteStream::AppendLC(CStreamStore& aStore,TStreamId anId)
191 /** Opens an existing stream, prepares it for appending, and puts a cleanup item
192 onto the cleanup stack.
194 The function leaves if it cannot complete successfully.
196 Putting a cleanup item onto the cleanup stack allows allocated resources to
197 be cleaned up if a subsequent leave occurs.
199 Note that call to this function must be matched by a call to CommitL() before
200 the RStoreWriteStream object is disposed of.
202 @param aStore A reference to the store containing the stream.
203 @param anId The id of the stream to be appended.
204 @see RWriteStream::Release()
205 @see RWriteStream::CommitL()
206 @see CDirectFileStore
207 @see CPermanentFileStore */
210 Sink()->SeekL(MStreamBuf::EWrite,EStreamEnd);