![Symbian OS Library](../../../../a_stock/mainheading.gif)
![]() |
![]() |
|
Location:
S32STRM.H
Link against: estor.lib
class RReadStream;
The read stream interface. The process of internalising from a stream is achieved through a reference to an object of this type.
A store aware class defines an implements an InternalizeL()
member function which is used to internalise that object and takes a reference to an RReadStream as the interface to the
read stream.
Defined in RReadStream
:
Attach()
, Close()
, Detach()
, Pop()
, PushL()
, RReadStream()
, RReadStream()
, ReadInt16L()
, ReadInt32L()
, ReadInt8L()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadL()
, ReadReal32L()
, ReadReal64L()
, ReadUint16L()
, ReadUint32L()
, ReadUint8L()
, Release()
, Source()
inline RReadStream();
Sets the stream buffer source to NULL, which implies that it is safe to close
inline RReadStream(MStreamBuf *aSource);
Constructs a read stream over the supplied stream buffer.
|
inline MStreamBuf *Source();
Gets the underlying stream buffer for the read stream. This provides access to the stream-buffer implementation used by the read stream.
Note:
If the stream buffer supports seeking, this allows the RReadStream client to have random access to the stream data.
|
IMPORT_C void Release();
Frees resources before abandoning the stream.
Note that, if a cleanup item for the stream was placed on the cleanup stack when the stream was opened by a call to OpenLC(),
then this function need not be called explicitly; clean up is implicitly done by CleanupStack::PopAndDestroy()
.
IMPORT_C void PushL();
Puts a cleanup item for this read stream object onto the cleanup stack. This allows allocated resources to be cleaned up if a subsequent leave occurs.
inline void Pop();
Removes the cleanup item for this read stream object from the cleanup stack.
IMPORT_C void ReadL(TDes8 &aDes);
Reads sufficient data from this stream to fill the specified 8 bit descriptor up to its maximum length. No other information is read from this read stream.
|
IMPORT_C void ReadL(TDes8 &aDes, TInt aLength);
Reads data of specified length from this stream into the specified 8 bit descriptor. No other information is read from this stream.
|
IMPORT_C void ReadL(TDes8 &aDes, TChar aDelim);
Reads data from this stream into the 8 bit descriptor, until either the specified delimiter is encountered or the descriptor is filled to its maximum length. The resulting data in aDes always includes the delimiter aDelim, if aDes is large enough.
|
IMPORT_C void ReadL(TUint8 *aPtr, TInt aLength);
Reads data of specified length from this stream into the location defined by the specified TUint8 pointer.
|
IMPORT_C void ReadL(TInt aLength);
Discards data of specified length read from this stream.
|
inline void ReadL(RWriteStream &aStream);
Writes the content of this stream to the specified write stream.
|
inline void ReadL(RWriteStream &aStream, TInt aLength);
Writes the content of this stream to the specified write stream.
|
IMPORT_C void ReadL(TDes16 &aDes);
Reads sufficient data from this stream to fill the specified 16 bit descriptor up to its maximum length. No other information is read from this read stream.
|
IMPORT_C void ReadL(TDes16 &aDes, TInt aLength);
Reads data of specified length from this stream into the specified 16 bit descriptor. No other information is read from this stream.
|
IMPORT_C void ReadL(TDes16 &aDes, TChar aDelim);
Reads data from this stream into the 16 bit descriptor, until either the specified delimiter is encountered or the descriptor is filled to its maximum length. The resulting data in aDes always includes the delimiter aDelim, if aDes is large enough.
|
IMPORT_C void ReadL(TUint16 *aPtr, TInt aLength);
Reads data of specified length from this stream into the specified 16 bit descriptor. No other information is read from this stream.
|
IMPORT_C TInt8 ReadInt8L();
Internalises a TInt8 value The function reads an 8Â bit value from this stream and interprets it as a TInt8.
|
IMPORT_C TInt16 ReadInt16L();
Internalises a TInt16 value. The function reads a 16Â bit value from this stream and interprets it as a TInt16.
|
IMPORT_C TInt32 ReadInt32L();
Internalises a TInt32 value. The function reads a 32Â bit value from this stream and interprets it as a TInt32.
|
IMPORT_C TUint8 ReadUint8L();
Internalises a TUint8 value. The function reads an 8Â bit value from this stream and interprets it as a TUint8.
|
IMPORT_C TUint16 ReadUint16L();
Internalises a TUint16 value. The function reads a 16Â bit value from this stream and interprets it as a TUint16.
|
IMPORT_C TUint32 ReadUint32L();
Internalises a TUint32 value. The function reads a 32Â bit value from this stream and interprets it as a TUint32.
|
IMPORT_C TReal32 ReadReal32L();
Internalises a TReal32 value. The function reads a 32Â bit value from this stream and interprets it as a TReal32.
|
IMPORT_C TReal64 ReadReal64L();
Internalises a TReal64 value. The function reads a 64Â bit value from this stream and interprets it as a TReal64.
|
protected: inline void Attach(MStreamBuf *aSource);
Sets the stream buffer source for this read stream. The existing source (if there is one) will be discarded.
This is useful for derived classes, enabling them to set the source following construction.
Note:
Release()
is not called on any discarded stream buffer.
|
protected: inline void Detach();
Sets the stream buffer source for this read stream to NULL. The existing source, if there is one, will be discarded.
Note that Release()
is not called on any discarded stream buffer.