#include <S32UCMP.H>
Link against:
estor.lib
class TUnicodeCompressor : public TUnicodeCompressionState;
Description
A class to hold functions to compress text using the Standard Compression Scheme for Unicode.
A note on error handling and leaving.
Although all the public functions except the constructor can leave, it is possible to guarantee success: that is, guarantee
that a call will not leave, and that compression will be completed. To do this, (i) supply a MUnicodeSource
object with a non-leaving ReadUnicodeValueL function, such as a TMemoryUnicodeSource
; (ii) write output to a RWriteStream
with a non-leaving WriteL function, or to a buffer that you already know to be big enough, which can be found out using CompressedSizeL.
This guarantee of success is particularly useful when compressing from one memory buffer to another.
Derivation
Members
Defined in TUnicodeCompressor
:
CompressL(RWriteStream &,MUnicodeSource &,TInt,TInt,TInt *,TInt *)
CompressL(TUint8 *,MUnicodeSource &,TInt,TInt,TInt *,TInt *)
CompressedSizeL(MUnicodeSource &,TInt)
FlushL(RWriteStream &,TInt,TInt &)
FlushL(TUint8 *,TInt,TInt &)
TUnicodeCompressor()
Inherited from TUnicodeCompressionState
:
Construction and destruction
IMPORT_C TUnicodeCompressor();
Description
CompressL(RWriteStream &,MUnicodeSource &,TInt,TInt,TInt *,TInt *)
IMPORT_C void CompressL(RWriteStream &aOutput, MUnicodeSource &aInput, TInt aMaxOutputBytes=KMaxTInt, TInt aMaxInputWords=KMaxTInt,
TInt *aOutputBytes=0,TInt *aInputWords=0);
Description
Parameters
CompressL(TUint8 *,MUnicodeSource &,TInt,TInt,TInt *,TInt *)
IMPORT_C void CompressL(TUint8 *aOutput, MUnicodeSource &aInput, TInt aMaxOutputBytes=KMaxTInt, TInt aMaxInputWords=KMaxTInt,
TInt *aOutputBytes=0,TInt *aInputWords=0);
Description
Parameters
FlushL(RWriteStream &,TInt,TInt &)
IMPORT_C TInt FlushL(RWriteStream &aOutput, TInt aMaxOutputBytes, TInt &aOutputBytes);
Description
Parameters
Return value
FlushL(TUint8 *,TInt,TInt &)
IMPORT_C TInt FlushL(TUint8 *aOutput, TInt aMaxOutputBytes, TInt &aOutputBytes);
Description
Parameters
Return value
CompressedSizeL(MUnicodeSource &,TInt)
IMPORT_C static TInt CompressedSizeL(MUnicodeSource &aInput, TInt aInputWords);
Description
Parameters
Return value