_COMPRESS_TEXT_STREAM SAP Method Kernel Method for Compression









Below is documentation, parameters and attributes of ABAP Method _COMPRESS_TEXT_STREAM within SAP class CL_ABAP_GZIP_TEXT_STREAM. There is also a number of example ABAP code snipts to help you use the functionality of this method.

This is a private Method so can only be executed from within the class itself. I.e. You could access it from another method of the class.

This method is available within SAP systems depending on your version and release level, you can view further information by entering the class name CL_ABAP_GZIP_TEXT_STREAM into the relevant SAP transactions such as SE24 or SE80, and then selecting the method you are interested in.


Method Type - Instance

This is an Instance Method so needs to be instantiated first before you can access any of the methods. I.e. you need to create a local variable of TYPE ref to the class.

The following technical details of method _COMPRESS_TEXT_STREAM can also be found below:

  • Importing parameters
  • Exporting parameters
  • Changing parameters
  • Returning parameters
  • Exceptions
  • Coding Examples


Parameters of Method _COMPRESS_TEXT_STREAM

.

NameTypeData TypeDescriptionDefault Value
CONVERSIONImportingTYPE
ABAP_ENCOD
Conversion to UTF8 (UC)
CS_INImportingTYPE
%_C_POINTER
Compress Handle
GZIP_OUT_FILLImportingTYPE
I
Fill Level of Output
STREAM_ENDImportingTYPE
ABAP_BOOL
End of Input
TEXT_INImportingTYPE
CSEQUENCE
Input text
TEXT_IN_LENImportingTYPE
I
Input Length
GZIP_OUTExportingTYPE
XSEQUENCE
Compressed output
GZIP_OUT_LENExportingTYPE
I
Output Length
CONV_TEXTChangingTYPE
XSEQUENCE
TEXT_IN_OFFChangingTYPE
I



Exceptions of Method _COMPRESS_TEXT_STREAM

GZIP_OUTExportingTYPE
XSEQUENCECompressed outputGZIP_OUT_LENExportingTYPE
IOutput LengthCX_SY_CONVERSION_CODEPAGE - System exception in character set conversion

Example ABAP coding

This is a private Method so the below code can only be executed from within the class itself. I.e. from another method of the class.

DATA: lo_class TYPE REF TO CL_ABAP_GZIP_TEXT_STREAM.
DATA: lv_CONVERSION TYPE ABAP_ENCOD,
lv_CS_IN TYPE %_C_POINTER,
lv_GZIP_OUT TYPE XSEQUENCE,
lv_GZIP_OUT_FILL TYPE I,
lv_GZIP_OUT_LEN TYPE I,
lv_STREAM_END TYPE ABAP_BOOL,
lv_TEXT_IN TYPE CSEQUENCE,
lv_TEXT_IN_LEN TYPE I,
lv_CONV_TEXT TYPE XSEQUENCE,
lv_TEXT_IN_OFF TYPE I,
lv_other TYPE c.

CALL METHOD lo_class=>_COMPRESS_TEXT_STREAM(
EXPORTING
CONVERSION = lv_CONVERSION
CS_IN = lv_CS_IN
GZIP_OUT_FILL = lv_GZIP_OUT_FILL
STREAM_END = lv_STREAM_END
TEXT_IN = lv_TEXT_IN
TEXT_IN_LEN = lv_TEXT_IN_LEN
IMPORTING
GZIP_OUT = lv_GZIP_OUT
GZIP_OUT_LEN = lv_GZIP_OUT_LEN
CHANGING
CONV_TEXT = lv_CONV_TEXT
TEXT_IN_OFF = lv_TEXT_IN_OFF ).

Links to Related Class(s)

CL_ABAP_...
Full list of available SAP object classes

Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!