SAP BAPI_XBP_JOB_SPOOLLIST_READ Function Module for Read the Spool List of an ABAP Job Step

Search SAP Function Modules

BAPI_XBP_JOB_SPOOLLIST_READ is a standard bapi xbp job spoollist read SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read the Spool List of an ABAP Job Step processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.

See here to view full function module documentation and code listing for bapi xbp job spoollist read FM, simply by entering the name BAPI_XBP_JOB_SPOOLLIST_READ into the relevant SAP transaction such as SE37 or SE38.

Function Group: SXBP
Program Name: SAPLSXBP
Main Program: SAPLSXBP
Appliation area: S
Release date: 29-Apr-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:

Function BAPI_XBP_JOB_SPOOLLIST_READ pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.

CALL FUNCTION 'BAPI_XBP_JOB_SPOOLLIST_READ'"Read the Spool List of an ABAP Job Step
  EXPORTING
   JOBNAME =  "Job Name
   JOBCOUNT =  "Job Count
   EXTERNAL_USER_NAME =  "Name of the SAP-External User
   STEP_NUMBER =  "Step Number

 IMPORTING
   RETURN =  "

TABLES
   SPOOL_LIST =  "Job Step Spool Request

.

IMPORTING Parameters details for BAPI_XBP_JOB_SPOOLLIST_READ

JOBNAME - Job Name

Data type: BAPIXMJOB-JOBNAME
Optional: No
Call by Reference: No ( called with pass by value option)

JOBCOUNT - Job Count

Data type: BAPIXMJOB-JOBCOUNT
Optional: No
Call by Reference: No ( called with pass by value option)

EXTERNAL_USER_NAME - Name of the SAP-External User

Data type: BAPIXMLOGR-EXTUSER
Optional: No
Call by Reference: No ( called with pass by value option)

STEP_NUMBER - Step Number

Data type: BAPIXMJOB-STEPCOUNT
Optional: No
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for BAPI_XBP_JOB_SPOOLLIST_READ

RETURN -

Data type: BAPIRET2
Optional: No
Call by Reference: No ( called with pass by value option)

TABLES Parameters details for BAPI_XBP_JOB_SPOOLLIST_READ

SPOOL_LIST - Job Step Spool Request

Data type: BAPIXMSPOO
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for BAPI_XBP_JOB_SPOOLLIST_READ Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

ABAP code using 7.40 inline data declarations to call FM BAPI_XBP_JOB_SPOOLLIST_READ

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

Search for further information about these or an SAP related objects