Gui_download parameter Description

The use of certain parameters in Function:gui_download.

??

? Call function ' Gui_download '

??? Exporting

*???? Bin_filesize??????????????????? =

*???? FileName??????????????????????? = P_file

*???? FILETYPE??????????????????????? = ' DAT '

*???? APPEND????????????????????????? = ' '

*???? Write_field_separator?????????? = ' X '

*???? HEADER????????????????????????? = ' 00 '

*???? Trunc_trailing_blanks?????????? = ' '

*???? WRITE_LF??????????????????????? = ' X '

*???? Col_select????????????????????? = ' '

*???? Col_select_mask???????????????? = ' '

*???? Dat_mode??????????????????????? = ' '

*???? Confirm_overwrite?????????????? = ' '

*???? No_auth_check?????????????????? = ' '

*???? CODEPAGE??????????????????????? = ' 4103 '

*???? Ignore_cerr???????????????????? = Abap_true

*???? Replacement???????????????????? = ' # '

*???? Write_bom?????????????????????? = ' X '

*???? Trunc_trailing_blanks_eol?????? = ' X '

*???? Wk1_n_format??????????????????? = ' '

*???? Wk1_n_size????????????????????? = ' '

*???? Wk1_t_format??????????????????? = ' '

*???? Wk1_t_size????????????????????? = ' '

*???? Write_lf_after_last_line??????? = Abap_true

*???? Show_transfer_status??????????? = Abap_true

*?? Importing

*???? Filelength????????????????????? =

*?? Tables

*???? Data_tab??????????????????????? = It_kna1

*???? FieldNames????????????????????? = it_filedname[]

*??? EXCEPTIONS

*???? File_write_error??????????????? = 1

*???? No_batch??????????????????????? = 2

*???? Gui_refuse_filetransfer???????? = 3

*???? Invalid_type??????????????????? = 4

*???? No_authority??????????????????? = 5

*???? Unknown_error?????????????????? = 6

*???? Header_not_allowed????????????? = 7

*???? separator_not_allowed?????????? = 8

*???? filesize_not_allowed??????????? = 9

*???? Header_too_long???????????????? = 10

*???? Dp_error_create???????????????? = 11

*???? Dp_error_send?????????????????? = 12

*???? Dp_error_write????????????????? = 13

*???? Unknown_dp_error??????????????? = 14

*???? Access_denied?????????????????? = 15

*???? Dp_out_of_memory??????????????? = 16

*???? Disk_full?????????????????????? = 17

*???? Dp_timeout????????????????????? = 18

*???? File_not_found????????????????? = 19

*???? Dataprovider_exception????????? = 20

*???? Control_flush_error???????????? = 21

*???? OTHERS????????????????????????? = 22.

??

1. Filetype:gui_download FILETYPE

' ASC ':

ASCII format. The table is transferred as text. Conversion exits is performed. The output format additionally depends on the parameters CODEPAGE, Trunc_trailing_blanks, and Trunc_trailing_blanks_eol.

' IBM ':

ASCII format with IBM codepage conversion (DOS). This format corresponds to the ' ASC ' format when using the target codepage 1103. This codepage was frequently used for data exchange via floppy disk.

' DAT ':

Column-by-column transfer. With this format, the data was transferred as text as with ASC. However, no conversion exits is performed and the columns is separated by tab characters. This format generates files than can be uploaded again using Gui_upload or ws_upload.

' DBF ':

Data is downloaded in dBase format. Since in this format the data types of the individual columns is stored as well, can often avoid import problems, for example, into Microsoft Excel, especially when interpreting numeric values.

' WK1 ':

Data is downloaded in Lotus format.

' BIN ':

Binary format. Data is transferred binarily. There is no formatting and no codepage conversion. The data is interpreted row by row; It is not a formatted by columns. Specify the data length in parameter bin_filesize. The table should consist of a column of type X, because especially in Unicode systems, the conversion of structured into B Inary data causes errors.

Default

' ASC '

2. APPEND

Gui_download APPEND

By default, existing local files is overwritten by new versions. By setting APPEND to ' X ', the downloaded data was appended to an existing file. If the file does not yet exist, it is created.

Value Range

' X '?? = Data is appended.

SPACE = Data is overwritten if the file already exists.

Default

SPACE

3. Write_field_separator

Gui_download Write_field_separator

In the downloaded file, the columns is separated by tab characters (Cl_abap_char_utilities=>horizontal_tab). You should use this setting if you want to upload the data from the file at a later time, because Identifying individual columns.

The parameter makes sense is only for the FILETYPE values ASC, DAT and IBM; For DAT it is set implicitly.

Value Range

' X '?? : Write separator.

Space:do not write separator.

Default

SPACE

4. Write_lf

Gui_download WRITE_LF

If This parameter are set, at the end of each row a row separator are inserted by CL_ABAP_CHAR_UTILITIES=>CR_LF. This parameter makes sense is only for FILETYPE ' ASC ', ' DAT ' and ' IBM '. If This parameter isn't set, blanks at the end of a row was not removed.

Value Range

' X ': Row separator is inserted.

Space:row separator is not inserted.

Default

X

5. Dat_mode

Gui_download Dat_mode

If parameter Dat_mode is set, the file is stored in ' DAT ' format. No conversion exits is performed. Number and date fields is stored in a standard format which makes it possible, to later import the file using Gui_upload.

Value Range

' X ': Dat_mode is switched on.

Space:dat_mode is isn't switched on.

Default

SPACE

6. CODEPAGE

Gui_download CODEPAGE

Use parameter CODEPAGE to specify the desired target CODEPAGE. If This parameter isn't set, the codepage of the SAP GUI is used as the target codepage.

Value Range

4-digit number of the SAP codepage. The function module Scp_codepage_by_external_name returns the SAP CODEPAGE number for a EXTERNAL character set NAME, for Example, "Iso-8859-1". The function module NLS_GET_FRONTEND_CP returns the appropriate Non-unicode FRONTEND codepage for a language.

You can determine the desired codepage interactively, if the parameter with_encoding of method File_save_dialog are set by Cl_gui_frontend_services.

Space:codepage of the SAP GUI

Default

SPACE

7. Replacement

Gui_download replacement

Specifies the replacement character to being used when during a character set conversion a character cannot is converted.

Value Range

An individual character.

Default

‘#‘

8. Write_bom

Gui_download Write_bom

If The data is written-a Unicode codepage, at the beginning of the file the respective byte order mark (BOM) is Inserte D.

unicode-little Endian? Codepage 4103, binary values ' FFFE '

unicode-big Endian? Codepage 4102, binary values ' FEFF '

UTF-8? Codepage 4110, binary values ' EFBBBF '

Note:microsoft Excel only supports Unicode data if they has been written in the format Unicode-little Endian.

Value Range

' X ': Write BOM.

Space:do not write BOM.

Default

SPACE

9. FieldNames

Gui_download FieldNames

Optional table with column names for the individual columns.

• ' DBF ': The column names is entered into the structure definition of the DBF file.
• ' DAT ':?? An additional row with the column names are inserted at the beginning of the table.

??

From

Gui_download parameter Description